From 04a1c0bec3c86f8d8130b7a5167043bf8fe85344 Mon Sep 17 00:00:00 2001 From: Fabian Alvarez <35088759+SantaCRC@users.noreply.github.com> Date: Wed, 22 Jan 2025 23:34:34 +0100 Subject: [PATCH 1/2] Create .readthedocs.yaml --- .github/workflows/.readthedocs.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/.readthedocs.yaml diff --git a/.github/workflows/.readthedocs.yaml b/.github/workflows/.readthedocs.yaml new file mode 100644 index 0000000..f72c324 --- /dev/null +++ b/.github/workflows/.readthedocs.yaml @@ -0,0 +1,22 @@ +# Read the Docs configuration file +# 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-24.04 + tools: + python: "3.13" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally, 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 From 38948f1ff927499059f6bcd1bc0f707e86ee6f16 Mon Sep 17 00:00:00 2001 From: Fabian Alvarez <35088759+SantaCRC@users.noreply.github.com> Date: Wed, 22 Jan 2025 23:39:04 +0100 Subject: [PATCH 2/2] Update .readthedocs.yaml --- .github/workflows/.readthedocs.yaml | 33 +++++++++++++++++++---------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/.github/workflows/.readthedocs.yaml b/.github/workflows/.readthedocs.yaml index f72c324..c5ea964 100644 --- a/.github/workflows/.readthedocs.yaml +++ b/.github/workflows/.readthedocs.yaml @@ -1,22 +1,33 @@ -# Read the Docs configuration file +# 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 +# Set the OS, Python version and other tools you might need build: - os: ubuntu-24.04 + os: ubuntu-22.04 tools: - python: "3.13" + python: "3.12" + # Uncomment and specify other tools if needed: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py + # Use the dirhtml builder for cleaner URLs (optional) + builder: "dirhtml" + # Fail on all warnings to avoid broken references + fail_on_warning: true -# Optionally, 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 +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + - epub + +# Declare Python requirements needed to build your documentation +python: + install: + - requirements: docs/requirements.txt