search

MESAHub / mesa

Modules for Experiments in Stellar Astrophysics
http://mesastar.org
GNU Lesser General Public License v2.1
146 stars 39 forks source link

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

Closed mjoyceGR closed 3 months ago

mjoyceGR commented 4 months ago

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 4 months ago

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

mjoyceGR commented 4 months ago

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

pmocz commented 4 months ago

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 3 months ago

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 3 months ago

I noticed that too. We are still sorting out some issues with readthedocs. We can point to stable, but stable is currently not actually getting tied to a version release number due to a missing feature (in-development) at readthedocs. Hopefully, this gets fixed soon.

Personally, I like pointing to latest by default, but I would like to know how others feel about that (I can see it being an issue if latest contains unreleased features, but a plus if changes in latest contain fixes that are relevant to previous versions).

On Mon, Aug 12, 2024 at 9:25 AM Lynn Buchele @.***> wrote:

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

— Reply to this email directly, view it on GitHub https://github.com/MESAHub/mesa/issues/691#issuecomment-2283988868, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABZESVJSHWZFVNC3DBLQ6NLZRCZTTAVCNFSM6AAAAABLO2XTMGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEOBTHE4DQOBWHA . You are receiving this because you were assigned.Message ID: @.***>

pmocz commented 3 months ago

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