Add warning banner to older versions of documentation

[melissawm]

📚 Documentation

From napari/napari#5096 (comment):

it would also be great if we had a nice colorful warning on the website that tells people that that's not the latest version (see for example the numpy docs)

[justinelarsen]

I think this is a much needed addition! Thanks for creating a separate issue @melissawm

It's interesting how the numpy docs only show the banner for versions 1.19 and older.

[melissawm]

@codemonkey800 is this something you might be able to do in the napari-sphinx-theme?

[melissawm]

Following up on this. Here's the current proposal to implement this directly into the pydata-sphinx-theme, and the related discussion

We can either wait for this to be implemented in the PyData Sphinx Theme and then cherrypick this into the napari sphinx theme, or echo that implementation in the napari theme right now, updating/removing it as it is merged into the PyData theme later. @codemonkey800 any thoughts?

[Nadalyn-CZI]

I think this is a great idea. When can we do it?

[melissawm]

Hi friends - here is a proof of concept using PyData Sphinx Theme's preliminary implementation:

https://melissawm.github.io/napari.github.io/0.4.15/index.html
https://melissawm.github.io/napari.github.io/0.4.16/index.html
https://melissawm.github.io/napari.github.io/0.4.17/index.html
https://melissawm.github.io/napari.github.io/dev/index.html

This is just a test, so I haven't enabled the banner in other pages, just the front page (ultimately I don't know that we want to have the warning here, but I just wanted to check that this would work.)

A few decisions are pending, for example the design which I'm not looking into at all so far.

This change will also involve multiple Pull Requests across the repos (napari/napari.github.io, napari/docs, napari/napari-sphinx-theme) and some manual tweaking of previous versions, which will only need to be done once. Because of this, I will wait for a definitive "go ahead" before doing anything.

[Nadalyn-CZI]

One of the things I really liked about the Sphinx one is that it had a colored background. I think this really helps draw attention to it. Can we do one with a colored background? I know we will have to be careful to keep it accessible for colorblind/sight challenged people but I think the majority of our users would benefit from it.

…

On Fri, Mar 3, 2023 at 9:27 AM Melissa Weber Mendonça < ***@***.***> wrote: Hi friends - here is a proof of concept using PyData Sphinx Theme's preliminary implementation: https://melissawm.github.io/napari.github.io/0.4.15/index.html https://melissawm.github.io/napari.github.io/0.4.16/index.html https://melissawm.github.io/napari.github.io/0.4.17/index.html https://melissawm.github.io/napari.github.io/dev/index.html This is just a test, so I haven't enabled the banner in other pages, just the front page (ultimately I don't know that we want to have the warning here, but I just wanted to check that this would work.) A few decisions are pending, for example the design which I'm not looking into at all so far. This change will also involve multiple Pull Requests across the repos (napari/napari.github.io, napari/docs, napari/napari-sphinx-theme) and some manual tweaking of previous versions, which will only need to be done once. Because of this, I will wait for a definitive "go ahead" before doing anything. — Reply to this email directly, view it on GitHub <#82 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A3CMNTB3NXNB2P5KLZGSNKDW2IEXJANCNFSM6AAAAAATKXFWPA> . You are receiving this because you commented.Message ID: ***@***.***>

[melissawm]

Sure! Like I said, design is still not a focus right now because I want to get a general "ok" first, but we certainly will need to think of that later.

[psobolewskiPhD]

As we discussed at the meeting, I personally think this would be extremely useful and helpful. It's not hard to find either google links, tutorials, image.sc posts, or zulip posts that link to out-dated docs.
Minor comment: for the dev version, I think something other than latest would be clearer? At least to me, as a user that sounds like the latest, most recent release, but those are actually the dev docs for the unreleased main napari, which is experimental to say the least.

[seankmartin]

I think that this would be great!

[psobolewskiPhD]

Bumping for non-zulipers, @melissawm posted how this could be implemented with links to her fork!
https://napari.zulipchat.com/#narrow/stream/212875-general/topic/Version.20warning.20banner.20for.20documentation/near/353976623

Super exciting!

[psobolewskiPhD]

Bumping this.
Looks like pydata theme did merge an implementation:
pydata/pydata-sphinx-theme#1354
I think we can "pick this up" with the new theme implementation:
napari/napari-sphinx-theme#134