Skip to content

Build docs from the extra that provides Sphinx #7834

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

Merged
ooctipus merged 3 commits into from
Sep 19, 2026
+10 −4
Merged

Build docs from the extra that provides Sphinx #7834

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
3e185ff
Build docs from the extra that provides Sphinx
vidurv-nvidia Sep 15, 2026
2479bf9
Align docs CLI test with the development extra
ooctipus Sep 17, 2026
73af9de
Merge branch 'develop' into vidurv/fix-docs-build-extra
ooctipus Sep 19, 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
6 changes: 6 additions & 0 deletions source/isaaclab/changelog.d/vidurv-fix-docs-build-extra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Fixed
^^^^^

* Fixed the ``isaaclab -d`` / ``./isaaclab.sh -d`` documentation build failing with
``No module named sphinx``. The command resolved its environment from the ``test`` extra,
which does not provide the Sphinx toolchain; it now uses the ``dev`` extra that declares it.
2 changes: 1 addition & 1 deletion source/isaaclab/isaaclab/cli/commands/misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def command_build_docs() -> None:
"run",
"--isolated",
"--extra",
"test",
"dev",

@greptile-apps greptile-apps Bot Sep 15, 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.

P1 Docs command test now fails

Changing this command to pass the dev extra leaves test_build_docs_runs_sphinx_with_the_uv_test_extra expecting --extra test. The targeted CLI test will fail until its expected command and name reflect the new docs environment.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

"--",
"python",
"-m",
Expand Down
6 changes: 3 additions & 3 deletions source/isaaclab/test/cli/test_misc_commands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ def test_new_runs_template_generator_directly():
run_python_command.assert_called_once_with(cli_script, ["--help"])


def test_build_docs_runs_sphinx_with_the_uv_test_extra():
"""The docs command must build through UV instead of an unpinned pip install."""
def test_build_docs_runs_sphinx_with_the_uv_dev_extra():
"""The docs command must use the UV extra that provides Sphinx."""
docs_dir = misc.ISAACLAB_ROOT / "docs"
output_dir = docs_dir / "_build" / "current"

Expand All @@ -41,7 +41,7 @@ def test_build_docs_runs_sphinx_with_the_uv_test_extra():
"run",
"--isolated",
"--extra",
"test",
"dev",
"--",
"python",
"-m",
Expand Down
Loading