Skip to content

Commit 47294a4

Browse files
committed
build: add generate api doc for docs
1 parent c672b25 commit 47294a4

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

.readthedocs.yaml

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,14 @@
1-
# Read the Docs configuration file
2-
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3-
4-
# Required
5-
version: 2
6-
7-
# Set the OS, Python version, and other tools you might need
81
build:
92
os: ubuntu-24.04
103
tools:
114
python: "3.13"
5+
commands:
6+
- pip install -r docs/docs-requirements.txt
7+
- pip install -e .[docs]
8+
- cd docs; python generate_docs.py
9+
- sphinx-build -b html docs/ $READTHEDOCS_OUTPUT/html/
1210

13-
# Build documentation in the "docs/" directory with Sphinx
14-
sphinx:
15-
configuration: docs/conf.py
16-
17-
# Optionally, but recommended,
18-
# declare the Python requirements required to build your documentation
19-
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
11+
# Remove the sphinx section since we're handling it manually
2012
python:
2113
install:
2214
- requirements: docs/docs-requirements.txt
23-
24-
# run the docs/generate_docs.py script to generate the documentation
25-
- run: python docs/generate_docs.py

0 commit comments

Comments
 (0)