What
Add read-only CI validation for the Python API documentation pipeline.
The workflow should build the generated Python API docs and validate the Docusaurus website without deploying or writing generated files back to the repository.
Why
Generated API documentation should be reproducible for contributors and reviewers. A read-only validation workflow catches broken docs builds early while avoiding the extra risk of write permissions, branch pushes, or deploy behavior.
Separating validation from preview/deploy automation makes the first CI step easier for maintainers to review.
How
Add a GitHub Actions workflow focused only on validation.
The update should:
- install the required Python docs dependencies
- run the Python API docs build
- validate the Docusaurus website build after API docs generation
- use path filters so the workflow runs on relevant documentation/API changes
- keep permissions read-only
Parent roadmap: #1361
What
Add read-only CI validation for the Python API documentation pipeline.
The workflow should build the generated Python API docs and validate the Docusaurus website without deploying or writing generated files back to the repository.
Why
Generated API documentation should be reproducible for contributors and reviewers. A read-only validation workflow catches broken docs builds early while avoiding the extra risk of write permissions, branch pushes, or deploy behavior.
Separating validation from preview/deploy automation makes the first CI step easier for maintainers to review.
How
Add a GitHub Actions workflow focused only on validation.
The update should:
Parent roadmap: #1361