Shows Iris version in sidebar (thus viewable on all pages)

[tkknight]

📚 Documentation

The documentation should ideally show the version of of Iris in the sidebar to make it easy for users to see, particular when read the docs shows stable.

Interim Solution

(#4030) is to add the version to the index title, but this only appears on the index page, not in the sidebar (and this every page). This is effectively option 1 from #3992

Long Term Solution

Either:

1. sphinx_rtd_theme is updated to include the option to show the version explicitly (Currently does not, see). This is essentially option 2 discussed on Which version is stable? #3992.

   • Check status on Display actual version number (possibly a new feature request) readthedocs/readthedocs.org#4529
   • Worth an occasional check of their changelog: https://sphinx-rtd-theme.readthedocs.io/en/stable/changelog.html

2. Iris logo svg implementation (SciTools/marketing#1) is completed and we have the option to add the version dynamically into the logo in the top of the sidebar. This is essentially option 3 discussed on Which version is stable? #3992.

[trexfeathers]

Here's a PoC for how option 2 could be achieved.

[tkknight]

I have method to achieve showing the iris version in the sidebar on my in dev (not quite done yet) adoption of the pydata theme. Will create the PR sometime soon.

[trexfeathers]

I have method to achieve showing the iris version in the sidebar on my in dev (not quite done yet) adoption of the pydata theme. Will create the PR sometime soon.

This will be good as we decided the text size in my PoC was a tad small and would be difficult to adjust to fit all possible uses.

[tkknight]

This is now resolved via #4661