fix(docs): Fix glossary FIXME tags #31674
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ions
Using `sphinx-prompt` in the `extensions` list causes a ModuleNotFoundError
when building the documentation via `make` or similar Sphinx commands:
ModuleNotFoundError: No module named `sphinx-prompt`
This happens because the correct Python module name is `sphinx_prompt`
(with an underscore), not a hyphen. Sphinx uses importlib to load extensions,
so the module name must be valid Python syntax.
This fixes the issue for contributors using `make` to build the docs locally.
|
Thanks for the PR @bl3ck. I don't think that the package name is wrong. It doesn't triggers any errors locally or in our CI jobs. On the opposite, the new name in this PRs makes the CI fail: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Fixes #31628
What does this implement/fix? Explain your changes.
Any other comments?
While working on #31628, I encountered a
ModuleNotFoundErrordue to a misnamed Sphinx extension (sphinx-promptinstead ofsphinx_prompt). This PR also fixes that to ensure local doc builds (make) work correctly.Setup