[Docs] Reinstate docs build gate for PRs (#59411)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Harry Mellor
2026-09-30 13:41:53 +01:00
committed by GitHub
co-authored by Claude Opus 5.5
parent effdea9a53
commit b22494cc0c
3 changed files with 6 additions and 10 deletions
+3
View File
@@ -135,6 +135,9 @@ API_AUTONAV_EXCLUDE=vllm mkdocs serve # API ref off (~15 seconds)
Once you see a `Serving on http://<address>:<port>/` line in the logs, the live preview is ready!
Open that address in your browser to see it — `http://127.0.0.1:8000/` by default, or whichever host/port you passed to `-a`.
On pull requests, Read the Docs builds a documentation preview only if the PR changes files that affect the docs (e.g. `docs/`, `examples/` or `mkdocs.yaml`) and the `pre-commit` checks have not failed.
Changes to `vllm/` alone do not trigger a build, so if your PR changes the API or CLI reference, add the `build-docs` label to force one.
For additional features and advanced configurations, refer to the:
- [MkDocs documentation](https://www.mkdocs.org/)