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

Adopt the Xanadu Sphinx Theme #20

Merged
merged 11 commits into from
May 2, 2022
Merged

Conversation

Mandrenkov
Copy link
Collaborator

Context:

Currently, all Xanadu OSS projects include their own version of the Xanadu Sphinx theme; however, the Xanadu Sphinx Theme repository is now publicly available and is the preferred way to access the Xanadu CSS theme and Sphinx directives.

Description of the Change:

  • Deleted the docs/xanadu_theme directory.
  • Updated docs/requirements.txt and docs/conf.py to reference and use the (centralized) Xanadu Sphinx Theme.
  • Added a Python 3.10 classifier to setup.py.

Benefits:

  • The size of this repository is smaller, meaning git clone will run faster.
  • Updates to the Xanadu Sphinx theme no longer have to be manually ported to this repository.

Possible Drawbacks:
None.

Related GitHub Issues:
Depends on XanaduAI/xanadu-sphinx-theme#2.

@Mandrenkov Mandrenkov marked this pull request as ready for review April 11, 2022 19:45
Copy link

@thisac thisac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cloned and built the docs, and it seems to work! The content side-bar didn't seem to scale correctly when shrinking the screen with. Other than that, everything looked great! 💯

.github/workflows/docs.yml Show resolved Hide resolved
@Mandrenkov
Copy link
Collaborator Author

Cloned and built the docs, and it seems to work!

Awesome, thanks for taking the time to build this locally, @thisac!

The content side-bar didn't seem to scale correctly when shrinking the screen with.

Great catch! 🎣 This issue has now been addressed by XanaduAI/xanadu-sphinx-theme@1e3b663. So, if you re-install the Xanadu Sphinx Theme, you should see that the local ToC is properly hidden for narrow viewports.

@Mandrenkov Mandrenkov merged commit 0177471 into main May 2, 2022
@Mandrenkov Mandrenkov deleted the sc-17457-xanadu-sphinx-theme branch May 2, 2022 13:45
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