Skip to content

Commit

Permalink
ci: update RTD configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleKing committed Sep 24, 2024
1 parent 782cb22 commit a79ff0f
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,28 @@
# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-lts-latest
tools:
python: "3.12"

# Build documentation in the docs/ directory with Sphinx
sphinx:
fail_on_warning: true
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optionally set the version of Python and requirements required to build your docs
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
version: '3.8'
install:
- requirements: docs/requirements.txt
install:
- requirements: docs/requirements.txt

0 comments on commit a79ff0f

Please sign in to comment.