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

Merged
merged 14 commits into from
May 2, 2022
Merged

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.

Note to Reviewers:
The Install and Circuits pages capture most of the representative changes between the Sphinx themes.

@Mandrenkov Mandrenkov requested a review from thisac April 14, 2022 14:41
@codecov
Copy link

codecov bot commented Apr 14, 2022

Codecov Report

Merging #701 (b42fb35) into master (d00f4ed) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #701   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files          75       75           
  Lines        9225     9225           
=======================================
  Hits         9107     9107           
  Misses        118      118           
Impacted Files Coverage Δ
strawberryfields/apps/train/__init__.py 100.00% <ø> (ø)
strawberryfields/tdm/tdmprogram.py 99.19% <ø> (ø)

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 d00f4ed...b42fb35. Read the comment docs.

@josh146
Copy link
Member

josh146 commented Apr 14, 2022

❤️

A couple of things I noticed while browsing around:

  • The logo and wordmark in the top left corner (image) should link to https://strawberryfields.ai. This is the first time I noticed this, since this is the first repo where the homepage != the docs homepage.

  • In the master branch, autosummary tables are fullwidth, but this is not the case in the centralized theme.

Copy link
Contributor

@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.

Just a minor thing. I noticed the hover text isn't visible when on the edge (not sure how easy this would be to fix).
Screen Shot 2022-04-14 at 11 05 50 AM

Also, a bummer that the font in the top left isn't "the Xanadu font" which was visible before when using an image instead.

doc/requirements.txt Outdated Show resolved Hide resolved
@Mandrenkov
Copy link
Contributor Author

Thanks for the review, @josh146!

  • The logo and wordmark in the top left corner should link to https://strawberryfields.ai. This is the first time I noticed this, since this is the first repo where the homepage != the docs homepage.

Nice catch! 🎣 I've updated the theme to support custom href targets for the logo and wordmark in the navigation bar.

Another great observation! 🔎 This has been fixed in the latest version of the centralized Xanadu Sphinx Theme.

@Mandrenkov
Copy link
Contributor Author

Thanks, @thisac!

Just a minor thing. I noticed the hover text isn't visible when on the edge (not sure how easy this would be to fix).

Good eye! 👁 I don't think this would be too difficult to fix; however, I would prefer to just remove the tooltips as they (mostly) just repeat the title of the gallery item anyway.

Also, a bummer that the font in the top left isn't "the Xanadu font" which was visible before when using an image instead.

Yes, agreed, although I stand by the decision to use a consistent font across all of our OSS projects to ensure the Sphinx assets look crisp and unified. If only we had access to the Xanadu wordmark font...

@Mandrenkov
Copy link
Contributor Author

As an update @thisac, after speaking with @josh146, I've restored the SF wordmark in the navigation bar.

@josh146
Copy link
Member

josh146 commented Apr 14, 2022

Thanks @Mandrenkov!

@Mandrenkov Mandrenkov merged commit 51af6ce into master May 2, 2022
@Mandrenkov Mandrenkov deleted the sc-17455-xanadu-sphinx-theme branch May 2, 2022 15:07
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.

3 participants