Skip to content

Commit

Permalink
chore: Update Read the Docs configuration for Sphinx documentation setup
Browse files Browse the repository at this point in the history
  • Loading branch information
cch1999 committed Jul 25, 2024
1 parent ec52dcd commit 3d904a5
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# .readthedocs.yaml
# 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
Expand All @@ -10,24 +9,27 @@ build:
os: ubuntu-22.04
tools:
python: "3.12"
# myst_parser: "2.0.0"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py
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
# - 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
# python:
# install:
# - requirements: docs/requirements.txt

0 comments on commit 3d904a5

Please sign in to comment.