Add nox -s inherited-theme
to check theme inheritance works
#648
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.
This PR adds a bare-bones
test_theme_inheritance
project that uses Sphinx's theme inheritance. This allows us to verify that theme inheritance continues to work. (See #204 for that feature request.)No stability guarantees
Furo makes zero guarantees about the stability of inheriting it as a theme. For example, the helper functions
_html_page_context
and_builder_inited
will stay private and may change at any time.The only guarantee—tested by this PR—is that it will be possible to inherit Furo. But how you do that may change.
Projects inheriting this theme are expected to pin to an exact Furo version, and closely check for changes when upgrading to a new version.