Allow inheriting Furo as a Sphinx theme #649
Closed
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
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.
To inherit Furo, the new Sphinx theme needs to call the setup code from
furo/__init__.py'ssetup. See #648 for an example.However, currently, these setup helper functions will not run if the theme is not set to Furo. (That's a good default behavior because it avoids Furo doing undesired things when you have Furo installed but aren't actually using it.)
So, this adds the argument
validate_furo: bool = Trueto both_html_page_contextand_builder_inited. That allows plugins to usefunctools.partialto set the argument toFalse, as done in #648.The default behavior is unaffected because the default is set to
True.