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

Modernize the Xanadu Sphinx Theme #2

Merged
merged 57 commits into from
Apr 29, 2022
Merged

Modernize the Xanadu Sphinx Theme #2

merged 57 commits into from
Apr 29, 2022

Conversation

Mandrenkov
Copy link
Collaborator

@Mandrenkov Mandrenkov commented Apr 11, 2022

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; the xanadu-sphinx-theme/ directory is also important, but that review can be limited to cosmetics and style.

Mandrenkov and others added 30 commits March 29, 2022 14:39
@Mandrenkov Mandrenkov marked this pull request as ready for review April 26, 2022 20:16
@Mandrenkov
Copy link
Collaborator Author

Mandrenkov commented Apr 26, 2022

This PR also addresses [sc-18723].

Copy link
Member

@josh146 josh146 left a 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?

.github/CHANGELOG.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.pylintrc Show resolved Hide resolved
MANIFEST.in Show resolved Hide resolved
setup.py Show resolved Hide resolved
xanadu_sphinx_theme/LICENSE Show resolved Hide resolved
README.rst Show resolved Hide resolved
xanadu_sphinx_theme/__init__.py Show resolved Hide resolved
xanadu_sphinx_theme/footer.html Show resolved Hide resolved
xanadu_sphinx_theme/globaltoc.html Show resolved Hide resolved
@Mandrenkov
Copy link
Collaborator Author

This is amazing work @Mandrenkov 💯

Thanks! Your help was greatly appreciated!

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?

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 html_sidebars appropriately.

@josh146
Copy link
Member

josh146 commented Apr 27, 2022

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 html_sidebars appropriately.

Oh does this mean that the Xanadu Sphinx theme can't be used for the QML/Photonics repo, since those themes deviate too much?

@Mandrenkov
Copy link
Collaborator Author

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.

@Mandrenkov Mandrenkov merged commit 708e1b9 into master Apr 29, 2022
@Mandrenkov Mandrenkov deleted the phoenix branch April 29, 2022 21:16
@Mandrenkov Mandrenkov restored the phoenix branch April 30, 2022 13:42
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.

2 participants