What
Upload Python API documentation preview artifacts for pull requests.
For relevant PRs, CI should upload generated Python API docs or a website build artifact that reviewers can download and inspect.
Why
Reviewers need a practical way to inspect generated documentation output without rebuilding everything locally. Artifacts provide a low-risk preview mechanism before considering branch previews or website deploy automation.
Keeping this separate from validation and deploy workflows makes permissions easier to reason about.
How
Build on the read-only docs validation workflow and add artifact upload for PR review.
The update should:
- generate the Python API docs or website preview output in CI
- upload preview artifacts for pull requests
- scope the workflow to Python API docs and website-relevant paths
- document how reviewers can download and inspect the artifacts
- avoid branch pushes and deployment credentials in this iteration
Out of scope:
- Rust API documentation artifacts
- deploying preview branches
- writing generated files back to the repository
- tag-triggered versioning
- changing the docs generation architecture
Parent roadmap: #1361
What
Upload Python API documentation preview artifacts for pull requests.
For relevant PRs, CI should upload generated Python API docs or a website build artifact that reviewers can download and inspect.
Why
Reviewers need a practical way to inspect generated documentation output without rebuilding everything locally. Artifacts provide a low-risk preview mechanism before considering branch previews or website deploy automation.
Keeping this separate from validation and deploy workflows makes permissions easier to reason about.
How
Build on the read-only docs validation workflow and add artifact upload for PR review.
The update should:
Out of scope:
Parent roadmap: #1361