Skip to content

Create configuration for doc publishing to RTD #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmgav merged 2 commits into from
Oct 17, 2025
Merged

Create configuration for doc publishing to RTD #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7200193
CI: add requirements for RTD
dmgav Oct 17, 2025
3f1e31a
CI: fix requirements-rtd.txt formatting
dmgav Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ build:
os: ubuntu-24.04
tools:
python: "3.13"
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv sync --group docs
- uv run python -m sphinx -T -b html -d docs/_build/doctrees -D language=en
docs $READTHEDOCS_OUTPUT/html

python:
install:
- requirements: requirements-rtd.txt

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py

8 changes: 8 additions & 0 deletions requirements-rtd.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
httpx
sphinx>=7.0
myst_parser>=0.13
sphinx_copybutton
sphinx_autodoc_typehints
sphinx_rtd_theme
numpydoc
ipython