From edaa3b91a3d5fef2755139a960ab6f1c0cbbeaea Mon Sep 17 00:00:00 2001 From: Matthew Watkins Date: Wed, 13 Mar 2024 17:32:50 +0000 Subject: [PATCH] Fix: Linux Foundation broken RTD documentation jobs Current documentation build jobs in readthedocs are failing. This adds the missing python dependenceis and configuration. Issue: RELENG-5212 Signed-off-by: Matthew Watkins --- .readthedocs.yaml | 27 +++++++++++++++++++++++++++ docs/requirements.txt | 2 ++ 2 files changed, 29 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..136a922b4 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,27 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..a8ed9418f --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +breathe +sphinx