Improve handling of style variable in template. #217
Conversation
This file contains 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
The `style` variable is missing in Sphinx 7. Instead, it now uses a list of `styles` [1]. This new list was already added in Sphinx 5.1. It looks like the `style` was only removed in Sphinx 7, though. This commit updates the `layout.html` template to define the styles variable if it is missing. This makes the change compatible with both Sphinx <5.1 and versions later than that. [1] https://www.sphinx-doc.org/en/master/development/templating.html#styles
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.
The
stylevariable is missing in Sphinx 7. Instead, it now uses a list ofstyles[1]. This new list was already added in Sphinx 5.1. It looks like thestylewas only removed in Sphinx 7, though.This commit updates the
layout.htmltemplate to define the styles variable if it is missing. This makes the change compatible with both Sphinx <5.1 and versions later than that.This change is enough to make our documentation buildable with Sphinx 7 when using this theme.
[1] https://www.sphinx-doc.org/en/master/development/templating.html#styles