Add qiskit theme based on Furo
#425
Merged
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
javabster
reviewed
Jun 29, 2023
coruscating
reviewed
Jun 30, 2023
| @@ -54,7 +54,7 @@ jobs: | |||
| rm -rf example_docs/_build_legacy | |||
| - name: Build Furo theme | |||
| run: | | |||
| THEME=_qiskit_furo tox run -e docs | |||
| THEME=qiskit tox run -e docs | |||
There was a problem hiding this comment.
Why's this tox syntax different from the examples you provide in the contributing guide, which don't use run?
There was a problem hiding this comment.
Tox 4 recommends using run for disambiguation. It's not actually necessary with our environments, but I did it in CI a while ago. But with CONTRIBUTING.md, it's annoying to type more characters so I kept it simple.
javabster
reviewed
Jun 30, 2023
javabster
approved these changes
Jun 30, 2023
This was referenced Jun 30, 2023
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.
Unblocks #232. With this PR, users will be able to set
html_theme = "qiskit"to use Furo.This PR adds instructions about how to migrate.
It also switches the default theme in
qiskit_sphinx_theme's example docs toqiskit. 95% of my work this month has been on Furo, so that's a better default.Reminder:
qiskit_ecosystemtheme upcomingOnce we add the Ecosystem theme, only Qiskit itself should use the
qiskittheme. In the meantime, everyone should migrate fromqiskit_sphinx_themetoqiskit(barring migration issues).