Documentation: Add information about version switching.

pyxem · Apr 22, 2024 · 7bc16af · 7bc16af
1 parent 2e2f5b4
commit 7bc16af
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/doc/conf.py b/doc/conf.py
@@ -110,7 +110,6 @@
     " <a href='https://www.ntnu.edu/web/temgemini/nordtemhub'>(Big) Data analysis of 4D-STEM</a> "
     " workshop in Trondheim, Norway, 11-13 June 2024",
     "switcher": {
-        # Update when merged and released
         "json_url": "https://pyxem.readthedocs.io/en/latest/_static/switcher.json",
         "version_match": version_match,
     },

diff --git a/doc/dev_guide/contributing.rst b/doc/dev_guide/contributing.rst
@@ -261,6 +261,10 @@ To make a new release, follow these steps:
 Then you can increase the version number in ``release_info.py`` to the next minor version
 and add a dev suffix (e.g. "0.17.dev0").
 
+After the new version documentation is public. You should update the doc/_static/switcher.json
+file with the new version of the documentation. This will ensure that the version switcher in the
+documentation is up to date.
+
 .. note::
    If any of the steps fail, you can restart the CI server by clicking on the "Re-run
    jobs" button on the GitHub Actions page. Sometimes the CI server fails because of