Add version switch to docs

[savente93]

Issue addressed

Fixes #188

Explanation

simplay followed the link and followed the docs. Works just fine. The only downside is that the older versions of the docs don't have this added so once you switch, the menu for it disapears. Can go back and retroactively add this back to the older versions if necessary, but this could give issues with reproducability (e.g. not sure if this plugin is compatable with older doc versions.)

Checklist

• Updated tests or added new tests
• Branch is up to date with main
• Tests & pre-commit hooks pass
• Updated documentation if needed
• Updated changelog.rst if needed

Additional Notes (optional)

Currently the url of the version switcher points to a file that will be deleted when the branch is deleted. Once this is approved, I'll switch it over to where the file will live after merging. This will temporary break the docs between update and merging as the file needs to be found for the docs to be generated, but should this should be fixed as soon as the merge is complete, so it should be fine.

[hboisgon]

Nice change! Thanks @savente93

[DirkEilander]

Looks good to me! Just one small addition, could you add a step to the release guide docs to make sure the switcher.json file gets updated on every release?

[DirkEilander]

The only downside is that the older versions of the docs don't have this added so once you switch, the menu for it disapears.

Can't we add this file to the root of the gh-pages branch directly? The url would than be "https://github.com/Deltares/hydromt/blob/gh-pages/switcher.json" and that should work for all versions right?

[savente93]

The only downside is that the older versions of the docs don't have this added so once you switch, the menu for it disapears.

Can't we add this file to the root of the gh-pages branch directly? The url would than be "https://github.com/Deltares/hydromt/blob/gh-pages/switcher.json" and that should work for all versions right?

That's actually a really good idea. Although it won't make it appear on the older versions, that is a config setting, so we'd have to go back to all the previous versions of the docs and add it to the config to solve this issue