[Do not merge] Proof of concept of theme variants #215
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
This was referenced Mar 16, 2023
Eric-Arellano
force-pushed
the
ecosystem-theme
branch
from
85d6522
to
90666e9
Compare
Eric-Arellano
added a commit
that referenced
this pull request
Mar 16, 2023
## Summary We plan to add variants of the Sphinx theme so that we can differentiate between Core vs the Ecosystem. They'll be distributed in the same package, and users only need to choose the `html_theme` in their `conf.py`. They will also share a "base" theme and override the CSS/images/HTML templates they care about. See #215 for an example of this. This PR reorganizes our folder structure so that we can add variants in followup PRs. ## Details We call the folder `pytorch_base` because we likely will want Pytorch-based variants for Core vs Ecosystem, and they'll use this folder as their base. Those variants will be added in follow ups. This also simplifies our `MANIFEST.in` and `setup.py` with @jakelishman's recommendation from #212 (review). The benefit of that is we make fewer changes when adding new theme variants (we have to add `graft qiskit_sphinx_theme/<variant>/static` to MANIFEST.in). I verified this works by using `python -m build` and inspecting the RECORD of the wheel, which shows the contents.
Eric-Arellano
force-pushed
the
ecosystem-theme
branch
from
90666e9
to
dc13cb3
Compare
|
Superseded by #229 |
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.
This sets up two theme variants:
qiskit_core__legacy_pytorchandqiskit_ecosystem__legacy_pytorch. Users only need to sethtml_themeto the variant they want inconf.py.For code reuse, the variants are built on top of a "base" Pytorch theme. The variants will inherit every part of this base theme, but can override things.
Images:
HTML templates (see the second line, middle):
For CSS, we have a file
overrides.css: