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 centralized Xanadu Sphinx Theme #287

Merged
merged 10 commits into from
May 4, 2022

Conversation

Mandrenkov
Copy link
Contributor

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 doc/xanadu_theme directory.
  • Updated doc/requirements.txt and doc/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.

@mlxd
Copy link
Member

mlxd commented Apr 26, 2022

image
Excellent!

@codecov
Copy link

codecov bot commented Apr 26, 2022

Codecov Report

Merging #287 (d8448ec) into master (6537614) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #287   +/-   ##
=======================================
  Coverage   98.86%   98.86%           
=======================================
  Files          27       27           
  Lines        2913     2913           
=======================================
  Hits         2880     2880           
  Misses         33       33           
Impacted Files Coverage Δ
pennylane_lightning/_version.py 100.00% <100.00%> (ø)

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 6537614...d8448ec. Read the comment docs.

@Mandrenkov
Copy link
Contributor Author

Hey @mlxd, I don't have permission to add reviewers to this PR.

Do you mind assigning this PR to yourself or someone else for review?

@josh146 josh146 requested a review from mlxd April 26, 2022 19:04
@chaeyeunpark
Copy link
Contributor

FYI, one of the workflows does not work if the PR is created from a forked repo. We just may ignore it, but could you update the version number in pennylane_lightning/_version.py? Just adding one to the dev number should be fine.

@Mandrenkov
Copy link
Contributor Author

Sure, @chaeyeunpark! Done.

@mlxd mlxd requested review from antalszava and albi3ro and removed request for mlxd May 2, 2022 13:54
Copy link
Contributor

@antalszava antalszava left a comment

Choose a reason for hiding this comment

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

Looks good 🎉 The docs seem to render well after skimming through a couple of pages. 👍 🙂

@mlxd mlxd merged commit ab04ed7 into PennyLaneAI:master May 4, 2022
@Mandrenkov Mandrenkov deleted the sc-17454-xanadu-sphinx-theme branch May 4, 2022 16:09
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