Skip to content

Commit

Permalink
Update .readthedocs.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
SantaCRC authored Jan 22, 2025
1 parent 04a1c0b commit 38948f1
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions .github/workflows/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 38948f1

Please sign in to comment.