Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add nox -s inherited-theme to check theme inheritance works #648

Closed

Conversation

Eric-Arellano
Copy link
Contributor

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.

@Eric-Arellano
Copy link
Contributor Author

Qiskit is planning to use theme inheritance with Qiskit/qiskit_sphinx_theme#269. I'll submit PRs to fix any future regressions to theme inheritance we notice when upgrading Furo.

So, this PR is less necessary and has the downside of additional complexity to Furo's repo.

Thanks again for your help with this topic!

@Eric-Arellano Eric-Arellano deleted the test-theme-inheritance branch April 19, 2023 14:42
@pradyunsg
Copy link
Owner

I'll add an equivalent to this at some point; once I find enough time to setup testing for this. Thanks for this PR! ^.^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants