DOC: Fix type of html_sidebars value in conf.py
#21200
Merged
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
lucascolley
approved these changes
Jul 16, 2024
html_sidebars value in conf.pyhtml_sidebars value in conf.py
|
It looks like we now have some new autosummary warnings: They look pretty straightforward so if you don't have the bandwidth @AA-Turner I'm happy to push a commit for that. Thanks! |
|
Feel free! I plan to release Sphinx 7.4.5 with the linked fix, and after that look into a few other autosummary issues that have been reported (sphinx-doc/sphinx#12589, sphinx-doc/sphinx#9743 (comment)). If this is one of those, or related, please let me know. A |
May be fixed by upstream in the future. [docs only]
|
It seems like it was indeed sphinx-doc/sphinx#12589, I am suppressing these warnings for now. Thanks! |
|
From local testing, I believe this also needs a backport.. |
5 tasks
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 issue
What does this implement/fix?
Support for string values in
html_sidebarshas been officially removed since Sphinx 2.0, but somehow seemed to work. Nevertheless, this resovlves the issue before a new version of Sphinx is resolved.Additional information
jinja2.exceptions.TemplateNotFounderror fromjinja2gluesphinx-doc/sphinx#12593 (comment) for an in-depth explanation.A