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

Add version switcher, favicon, and context-dependent logo #586

Merged
merged 7 commits into from
Sep 9, 2024

Conversation

nwlandry
Copy link
Collaborator

@nwlandry nwlandry commented Sep 8, 2024

Fixes #584 and #585.

This PR

  • Adds a favicon
  • Creates a dark and light version of the logo
  • Adds a version switcher

@nwlandry nwlandry linked an issue Sep 8, 2024 that may be closed by this pull request
Copy link

codecov bot commented Sep 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.14%. Comparing base (bc9a30b) to head (3f65f20).
Report is 54 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #586   +/-   ##
=======================================
  Coverage   93.13%   93.14%           
=======================================
  Files          60       60           
  Lines        4503     4506    +3     
=======================================
+ Hits         4194     4197    +3     
  Misses        309      309           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nwlandry nwlandry requested a review from maximelucas September 8, 2024 03:13
@maximelucas
Copy link
Collaborator

maximelucas commented Sep 8, 2024

Amazing Nich!! Favicon is a sweet plus.

Two things:

  1. On my laptop the menu is now looking a bit strange because on two lines
  2. the light theme logo doesn't have a margin anymore so it's stuck to the "new release" button (dark theme logo doesn't have that problem)

image

I'm not fully sure how to solve 1., I think we need to find a way to control the width of the 3 navbars/zones (left, middle, right)? Can the version switcher be made less wide by changing the default text from "choose version" to "vesion" or simply "stable" by default? The "search" box also takes a lot of space.

@nwlandry
Copy link
Collaborator Author

nwlandry commented Sep 9, 2024

In response to the review I

  • reverted the logo back
  • adjusted the spacing in the navbar
  • Added a call to the Github API to get the date of the latest release

I believe I addressed all your comments, @maximelucas!

docs/source/conf.py Outdated Show resolved Hide resolved
@@ -184,6 +201,13 @@
"icon": "fa-brands fa-mastodon", # Font Awesome icon
},
],
"header_links_before_dropdown": 4,
Copy link
Collaborator

@maximelucas maximelucas Sep 9, 2024

Choose a reason for hiding this comment

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

Any way of having 5 and keeping the Gallery visible (not in dropdown)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The issue was that I wanted everything on one line even when the user wasn't in full-screen, which is basically impossible unless the navbar is slimmed down. So I will keep it like it is for now, and then change it later if need be.

@maximelucas
Copy link
Collaborator

You're on fire, the automatic date retrieval is great!!
Two tiny comments but I'll let you choose, approving already.

Co-authored-by: Maxime Lucas <[email protected]>
@nwlandry
Copy link
Collaborator Author

nwlandry commented Sep 9, 2024

Thanks for the review!

@nwlandry nwlandry merged commit 5b08511 into main Sep 9, 2024
24 checks passed
@nwlandry nwlandry deleted the more-website-fixes branch September 9, 2024 11:58
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.

add dark version of logo to online docs add version switcher to online docs
2 participants