Skip to content

Commit 0bdd834

Browse files
authored
Update .readthedocs.yaml
1 parent 7a35455 commit 0bdd834

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

py/docs/.readthedocs.yaml

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,31 @@
11
# .readthedocs.yaml
2-
# configuration file for publishing Python API documentation on "Read the Docs"
3-
#
4-
# configuration file reference: https://docs.readthedocs.io/en/stable/config-file/v2.html
5-
# job configuration: https://app.readthedocs.org/projects/selenium-python-api-docs
6-
# published docs: https://selenium-python-api-docs.readthedocs.io
2+
# ✅ Configuration file for building and publishing Selenium's Python API docs using Read the Docs.
3+
# ℹ️ Reference: https://docs.readthedocs.io/en/stable/config-file/v2.html
74

8-
version: 2
5+
version: 2 # ✅ YAML schema version (v2 is current as per ReadTheDocs)
96

107
build:
11-
os: ubuntu-24.04
8+
os: ubuntu-24.04 # ✅ Use Ubuntu 24.04 as build environment
9+
1210
tools:
13-
python: "3.12"
11+
python: "3.12" # ✅ Use Python version 3.12
12+
1413
commands:
14+
# ✅ Install documentation-specific dependencies (like Sphinx and extensions)
1515
- pip install -r py/docs/requirements.txt
16+
17+
# ✅ Install main Python dependencies for Selenium (may be required by docstrings)
1618
- pip install -r py/requirements.txt
19+
20+
# ✅ Generate dynamic module listing before building the docs
1721
- cd py && python3 generate_api_module_listing.py && cd
22+
23+
# ✅ Automatically generate API stub `.rst` files using autodoc
1824
- PYTHONPATH=py sphinx-autogen -o $READTHEDOCS_OUTPUT/html py/docs/source/api.rst
25+
26+
# ✅ Build HTML docs using Sphinx with correct path
1927
- PYTHONPATH=py sphinx-build -b html -d build/docs/doctrees py/docs/source $READTHEDOCS_OUTPUT/html
2028

2129
sphinx:
22-
configuration: py/docs/source/conf.py
30+
configuration: py/docs/source/conf.py # ✅ Main Sphinx configuration file path
31+

0 commit comments

Comments
 (0)