readthedocs changes October 7 2024

[hkershaw-brown]

[Action required] Deprecation: Removal of Sphinx context injection at build time https://about.readthedocs.com/blog/2024/07/addons-by-default/

Deprecation timeline We understand this change will affect thousands of projects, so we have a timeline to communicate this deprecation to our users effectively.

July 29, 2024: disable Sphinx context injection and enable Read the Docs Addons for all new projects created. October 7, 2024: disable Sphinx context injection and enable Read the Docs Addons for all projects.

[hkershaw-brown]

turned on addons and built readthedocs-test https://docs.dart.ucar.edu/en/readthedocs-test/ seems fine. Edit (ish)

Flyout menu location is not great

Order of versions is incorrect in the menu

Switched off notification for 'latest'. 'latest' and 'stable' are the same for DART.

using SemVer order, better but backwards. Toggling flyout sorting does not seem to make a difference.

[hkershaw-brown]

@ann-norcio @c-merchant @Benjamin-Gunn If you get a chance can you have a click around https://docs.dart.ucar.edu/en/readthedocs-test/ Readthedocs are updating how they build the documentation so it would be good to catch any weirdness before the Oct 7th switchover.

[hkershaw-brown]

having the add on seems to break the search on the 'lastest' docs. bummer.

[hkershaw-brown]

switched off the addons for now and rebuilt 'latest'

[ann-norcio]

Noticed the same things Helen pointed out while clicking around https://docs.dart.ucar.edu/en/readthedocs-test/

• The versions are not listed in the correct order on the flyout menu
• Formatting of the table here is off, but it's also that way in the 'latest' version

[hkershaw-brown]

note on redirects.

old versions of the docs have README.html The flyout links are index.html

If you redirect from as specific version /en/vX/ -> /en/vX/README.html you can use the flyout menu from new to old, but not old new.

[hkershaw-brown]

general one way and specific back fixes the old doc flyout 404

Note delete these if the redirects cause problems