Skip to content

Commit

Permalink
Fix readthedocs configuration (#3845)
Browse files Browse the repository at this point in the history
- Rename readthedocs.yml to .readthedocs.yml, 
- update to Ubuntu 22.04 and Python 3.12, 
- add uv setup and Sphinx build commands.
  • Loading branch information
jstvz authored Nov 15, 2024
1 parent 5edef21 commit 5ae0e51
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions readthedocs.yml → .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,15 @@ version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
os: ubuntu-22.04
tools:
python: "3.9"
python: "3.12"
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv sync --only-group docs --frozen
- uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand All @@ -19,8 +25,3 @@ sphinx:
formats:
- pdf
- epub

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements_dev.txt

0 comments on commit 5ae0e51

Please sign in to comment.