MESAHub/mesa

Feature request: warning banner when viewer is not looking at the most recent version of mesa readthedocs

mjoyceGR opened this issue · 6 comments

mjoyceGR commented

By request at the MESA Down Under Summer School: put in a warning banner at the top of docs.mesastar.org if a viewer is not looking at the most recent version of the documentation

pmocz commented

Since we do not use version tags that follow semver as specified by the PEP 440, readthedocs cannot automatically detect the stable version to add the version warning banner

I added a new Custom Automation rule in the readthedocs admin panel which should kick in when we release our next version (and hopefully make banners appear automatically)

Reference:
https://docs.readthedocs.io/en/stable/guides/automation-rules.html

  • ❤️1
mjoyceGR commented

awesome! is there a way to test this before posting a new release?

pmocz commented

Unfortunately readthedocs currently does not provide a way to test this feature. But as soon as we create a new github tag, it should activate

BucheleL commented

I can now see a banner on the website! This might be a small detail, but it does point to the latest stable version rather than the latest formal release (i.e. I still get the banner even if I'm looking at docs for r24.03.1).

pmocz commented
pmocz commented

The banner issue is finally fixed by tweaking our tags to follow PEP440 standards

  • ❤️1