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 #126

Merged
merged 9 commits into from
May 2, 2022

Conversation

Mandrenkov
Copy link
Contributor

@Mandrenkov Mandrenkov commented Apr 12, 2022

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.

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 and implements [sc-17452].

@codecov
Copy link

codecov bot commented Apr 12, 2022

Codecov Report

Merging #126 (e887391) into main (0fe12a3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #126   +/-   ##
=======================================
  Coverage   68.69%   68.69%           
=======================================
  Files          26       26           
  Lines        2734     2734           
=======================================
  Hits         1878     1878           
  Misses        856      856           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0fe12a3...e887391. Read the comment docs.

@thisac thisac requested review from thisac and ziofil April 13, 2022 19:42
@ziofil
Copy link
Collaborator

ziofil commented Apr 13, 2022

cool! How do I visualize the changes? Do I need to compile the docs?

@Mandrenkov
Copy link
Contributor Author

cool! How do I visualize the changes? Do I need to compile the docs?

Yeah, exactly! Just install doc/requirements.txt and friends, run make html in the Sphinx documentation directory, and open doc/_build/html/index.html in your favourite browser. There may also be a way to get Read the Docs to build it for you.

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.

💯

@Mandrenkov Mandrenkov merged commit 30f8852 into XanaduAI:main May 2, 2022
@Mandrenkov Mandrenkov deleted the sc-17452-xanadu-sphinx-theme branch May 2, 2022 15:08
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.

4 participants