Skip to content

Commit 27036d6

Browse files
docs: add bazel sphinx_build_test replicating ReadTheDocs CI
Adds a hermetic Bazel `py_test` target that runs the same Sphinx documentation build performed by readthedocs.org/openroad, catching broken cross-references, malformed markup, missing files, and toc.yml issues locally before they reach CI. - `//docs:sphinx_build_test` runs `sphinx-build -b html` with pinned Python deps from `@openroad-pip` (no system Sphinx required). - Tagged `doc_check` for filtering: `bazelisk test --test_tag_filters=doc_check //docs/...`. - Mirrors conf.py setup (main symlink, README2.md prefix swap, messages glossary generation, doxygen stub) and strips `bazel-*` symlinks to prevent recursive scanning. Fixes #9885 Signed-off-by: alokkumardalei-wq <alokkumardalei2@gmail.com>
1 parent bf6f201 commit 27036d6

5 files changed

Lines changed: 660 additions & 1 deletion

File tree

bazel/requirements.in

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
11
tclint==0.7.0
2+
3+
# Sphinx documentation build (replicates ReadTheDocs CI check)
4+
# See: https://github.com/The-OpenROAD-Project/OpenROAD/issues/9885
5+
sphinx
6+
sphinx-book-theme
7+
sphinx-copybutton
8+
sphinx-external-toc==0.3.1
9+
sphinx-tabs
10+
sphinxcontrib-mermaid
11+
myst-parser

0 commit comments

Comments
 (0)