Update announcement and version switcher #807
Conversation
github-actions
bot
added
the
documentation
willingc
changed the title
|
Has 2 banner headers, which I thought we turned off at one point. But I might not be used to it, given that I guess its been quietly broken for a while? |
| <!-- This will appear in the announcement banner at the top of the site. | ||
| It needs to be activated by passing the link: | ||
| "https://napari.org/dev/_static/announcement.html" | ||
| "https://raw.githubusercontent.com/napari/docs/main/docs/_templates/announcement.html", |
There was a problem hiding this comment.
Can you explain to me this change? I don't understand why its different
in part because I don't see an announcment html in the _templates
There was a problem hiding this comment.
Ugh. Because I pulled the was moving the announcement.html into _templates where it belongs since it is currently in _static. And then I changed my mind. I will update the comment.
There was a problem hiding this comment.
Changed my mind again and am moving announcements.html into _templates to be consistent with pydata sphinx themes approach
|
@TimMonko Check out the pydata sphinx theme docs for examples of two banners. We could style the colors with css. |
|
Thanks! Excited to have the banner back. |
|
I'm sorry I was too slow to review 😅 - I am undoing some of this PR in #811 since (I think) we don't want the announcement banner. We can also think about ways to document these decisions in the docs working group if it helps. Thanks! |
# References and relevant issues Related to #807 and #801 # Description Deactivates the announcement banner and moves the template back to _static. The reason the templates needs to live in _static is that we want to be able to do updates to the banner without rebuilding the full docs site (see https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/announcements.html#update-or-remove-announcement-banner) Also remove redundant logic for the version switcher.
3 participants
References and relevant issues
Closes #801
Description
This PR makes the following changes:
Testing
I wasn't sure a good way to test the version switcher with PRs. Checked the pydata sphinx theme repo but their CI seems to also redirect to live versions.