-
Notifications
You must be signed in to change notification settings - Fork 1
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
Modernize the Xanadu Sphinx Theme #2
Conversation
This PR also addresses [sc-18723]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is amazing work @Mandrenkov 💯
I have one minor question: how do you configure the theme to look like the QML/photonics website, rather than the docs? E.g., hidden left navbar, maybe differently centered pages, different shadows?
Thanks! Your help was greatly appreciated!
I'm not sure about the latter two (perhaps including a local CSS file would work), but I know the first one can be configured by setting |
Oh does this mean that the Xanadu Sphinx theme can't be used for the QML/Photonics repo, since those themes deviate too much? |
Hmm, I think it is still possible to reuse the Xanadu Sphinx Theme for those websites. Sure, some modifications will be necessary, but I don't think the XST is fundamentally incompatible with those projects. |
This PR updates the existing Xanadu Sphinx Theme to reflect the aesthetics and customization that is currently implemented, to various degrees, by other Xanadu OSS projects, including:
A comprehensive
.github/
directory is also included in this PR. Once merged, v0.1.0 of the XST will be published to PyPI.Note to Reviewers:
Clearly, this is a huge PR with many changes; however, most of these modifications have already been indirectly approved through the PRs linked above. I would suggest taking a closer look at the files inside
.github/
as well as the root directory; thexanadu-sphinx-theme/
directory is also important, but that review can be limited to cosmetics and style.