Skip to content

Commit

Permalink
docs: setup uv for readthedocs (#54)
Browse files Browse the repository at this point in the history
* docs: setup uv for readthedocs

* Update .readthedocs.yaml

* require sphinx >=4.2
  • Loading branch information
njzjz authored Apr 18, 2024
1 parent c726d14 commit 4a08f18
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
11 changes: 5 additions & 6 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ build:
os: ubuntu-22.04
tools:
python: "3.10"

jobs:
post_create_environment:
- pip install uv
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install -r docs/requirements.txt
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats: all

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx >=4.2
sphinx_rtd_theme
.
myst_parser
Expand Down

0 comments on commit 4a08f18

Please sign in to comment.