search

spyder-ide / spyder-docs

Documentation for Spyder, the Scientific Python Development Environment
https://docs.spyder-ide.org
MIT License
33 stars 283 forks source link

PR: Add banner for out of date and development versions #290

Closed CAM-Gerlach closed 2 years ago

CAM-Gerlach commented 2 years ago

Pull Request

Pull Request Checklist

Description of Changes

Adds an alert banner to the top of the docs for development (currently just feature branches, but will include master assuming we branch 5.x before Spyder 6 is released) and outdated (Spyder 3, Spyder 4) versions that states this and links to the latest supported stable version.

Requires spyder-ide/spyder-docs-sphinx-theme#44 (which in turn is waiting on spyder-ide/spyder-docs-sphinx-theme#43 ) to be merged and the temp commit dropped before merging, but those both should hopefully be merged very soon.

Issue(s) Resolved

Fixes #188

juanis2112 commented 2 years ago

Right now this is for master branch if I understand correctly? But not sure why we need to say this if spyder 5 docs are almost ready.

CAM-Gerlach commented 2 years ago

@juanis2112 Actually, the current wording refers more to development and outdated versions of Spyder, rather than the docs specifically, to let people know that they are using the docs for an outdated version, or an unstable development version (once we branch the 5.x docs and start the docs for Spyder 6) that is not yet the current stable, and offering a direct link to the current version of the same page. This is what most other projects do, and matches the example shown in the sphinx-multiversion docs.

EDIT: Also, this is going in 4.x and will be merged to master, to keep them in sync for now (all the branch-specific logic is done in JS, which gets applied to all versions).

Ideally, we'd keep the dev status of Spyder and its docs roughly in sync (at least in terms of major releases). However, these improvements allow us to customize the docs banner to say whatever we want (or not appear at all) on specific version(s), so the message could be changed to refer to the development status of the docs too (or even add a separate one); but as you say, no real need for that right now.

juanis2112 commented 2 years ago

Oh got it. Sorry for the confusion. This is fine then

CAM-Gerlach commented 2 years ago

Thanks for the review, @juanis2112 . This is currently blocked on the trivial spyder-ide/spyder-docs-sphinx-theme#44 being merged.

CAM-Gerlach commented 2 years ago

spyder-ide/spyder-docs-sphinx-theme#44 was merged, so this is ready to go. I'll implement a more reliable fix to the flaky Gentoo link in my next PR, which among other thing backports the pre-commit, build, CI and linkcheck fixes, upgrades and improvements made in master and other repos to 4.x.