Skip to content

docs: add bazel sphinx_build_test replicating ReadTheDocs CI #10184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alokkumardalei-wq wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: add bazel sphinx_build_test replicating ReadTheDocs CI #10184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
589c095
docs: add bazel sphinx_build_test replicating ReadTheDocs CI
alokkumardalei-wq Apr 19, 2026
8aac486
docs: address review feedback on sphinx_build_test
alokkumardalei-wq Apr 24, 2026
c0c5098
Merge branch 'master' into feature/bazel-sphinx-test
alokkumardalei-wq Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ exports_files([
"BUILD.bazel",
"LICENSE",
"MODULE.bazel",
"README.md",
"src/Design.i",
"src/Exception.i",
"src/options.i",
Expand Down
17 changes: 17 additions & 0 deletions bazel/requirements.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# Pinned dependencies for the Bazel Python toolchain (Python 3.13).
# Compiled into bazel/requirements_lock_3_13.txt via
# bazel run //bazel:requirements.update

tclint==0.7.0

# Sphinx documentation build (replicates ReadTheDocs CI check)
# See: https://github.com/The-OpenROAD-Project/OpenROAD/issues/9885

@luarss luarss Apr 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which python version is this requirements.in for? also can you please lock them with ==

@alokkumardalei-wq alokkumardalei-wq Apr 24, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@luarss done, pinned all Sphinx deps with == in 8aac486 and added a header clarifying this is the Python 3.13 toolchain's input (the lock file is bazel/requirements_lock_3_13.txt). Regenerated via bazelisk run //bazel:requirements.update; the lock is unchanged since the pins match the previously resolved versions.

sphinx==5.3.0
sphinx-book-theme==1.1.3
sphinx-copybutton==0.5.2
sphinx-external-toc==0.3.1
sphinx-tabs==3.4.7
sphinxcontrib-mermaid==2.0.1
myst-parser==1.0.0
# imghdr was removed from the Python 3.13 stdlib; sphinx.builders.epub3 still
# imports it. The standard-imghdr backport restores the module.
standard-imghdr==3.13.0
Loading
Loading