Merge pull request #3125 from agriyakhetarpal/version-json-fix

Updates for `versions.json` and related configuration
pybamm-team · Jul 8, 2023 · e3dbcfb · e3dbcfb
2 parents 5486fce + b08c859
commit e3dbcfb
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 68 deletions.
diff --git a/.github/release_checklist.md b/.github/release_checklist.md
@@ -5,6 +5,8 @@
     - `docs/conf.py`
     - `CITATION.cff`
     - `vcpkg.json`
+    - `docs/source/_static/versions.json`, and check if any links fail
+
   - Update baseline of registries in `vcpkg-configuration.json` as the latest commit id from [pybamm-team/sundials-vcpkg-registry](https://github.com/pybamm-team/sundials-vcpkg-registry)
   - Update `CHANGELOG.md` with a summary of the release
 

diff --git a/docs/source/_static/versions.json b/docs/source/_static/versions.json
@@ -2,135 +2,166 @@
     {
         "name": "latest",
         "version": "latest",
-        "url": "https://pybamm.readthedocs.io/en/latest/"
+        "url": "https://docs.pybamm.org/en/latest/"
     },
     {
         "name": "stable",
         "version": "stable",
-        "url": "https://pybamm.readthedocs.io/en/stable/"
+        "url": "https://docs.pybamm.org/en/stable/"
     },
     {
-        "version": "v23.5",
-        "url": "https://pybamm.readthedocs.io/en/v23.5/"
+        "name": "v23.5",
+        "version": "23.5",
+        "url": "https://docs.pybamm.org/en/v23.5_a/"
     },
     {
-        "version": "v23.4.1",
-        "url": "https://pybamm.readthedocs.io/en/v23.4.1/"
+        "name": "v23.4.1",
+        "version": "23.4.1",
+        "url": "https://docs.pybamm.org/en/v23.4.1/"
     },
     {
-        "version": "v23.4",
-        "url": "https://pybamm.readthedocs.io/en/v23.4/"
+        "name": "v23.4",
+        "version": "23.4",
+        "url": "https://docs.pybamm.org/en/v23.4/"
     },
     {
-        "version": "v23.3",
-        "url": "https://pybamm.readthedocs.io/en/v23.3/"
+        "name": "v23.3",
+        "version": "23.3",
+        "url": "https://docs.pybamm.org/en/v23.3/"
     },
     {
-        "version": "v23.2",
-        "url": "https://pybamm.readthedocs.io/en/v23.2/"
+        "name": "v23.2",
+        "version": "23.2",
+        "url": "https://docs.pybamm.org/en/v23.2/"
     },
     {
-        "version": "v23.1",
-        "url": "https://pybamm.readthedocs.io/en/v23.1/"
+        "name": "v23.1",
+        "version": "23.1",
+        "url": "https://docs.pybamm.org/en/v23.1/"
     },
     {
-        "version": "v22.12",
-        "url": "https://pybamm.readthedocs.io/en/v22.12/"
+        "name": "v22.12",
+        "version": "22.12",
+        "url": "https://docs.pybamm.org/en/v22.12/"
     },
     {
-        "version": "v22.11.1",
-        "url": "https://pybamm.readthedocs.io/en/v22.11.1/"
+        "name": "v22.11.1",
+        "version": "22.11.1",
+        "url": "https://docs.pybamm.org/en/v22.11.1/"
     },
     {
-        "version": "v22.11",
-        "url": "https://pybamm.readthedocs.io/en/v22.11/"
+        "name": "v22.11",
+        "version": "22.11",
+        "url": "https://docs.pybamm.org/en/v22.11/"
     },
     {
-        "version": "v22.10",
-        "url": "https://pybamm.readthedocs.io/en/v22.10/"
+        "name": "v22.10",
+        "version": "22.10",
+        "url": "https://docs.pybamm.org/en/v22.10/"
     },
     {
-        "version": "v22.9",
-        "url": "https://pybamm.readthedocs.io/en/v22.9/"
+        "name": "v22.9",
+        "version": "22.9",
+        "url": "https://docs.pybamm.org/en/v22.9/"
     },
     {
-        "version": "v22.8",
-        "url": "https://pybamm.readthedocs.io/en/v22.8/"
+        "name": "v22.8",
+        "version": "22.8",
+        "url": "https://docs.pybamm.org/en/v22.8/"
     },
     {
-        "version": "v22.7",
-        "url": "https://pybamm.readthedocs.io/en/v22.7/"
+        "name": "v22.7",
+        "version": "22.7",
+        "url": "https://docs.pybamm.org/en/v22.7/"
     },
     {
-        "version": "v22.6",
-        "url": "https://pybamm.readthedocs.io/en/v22.6/"
+        "name": "v22.6",
+        "version": "22.6",
+        "url": "https://docs.pybamm.org/en/v22.6/"
     },
     {
-        "version": "v22.5",
-        "url": "https://pybamm.readthedocs.io/en/v22.5/"
+        "name": "v22.5",
+        "version": "22.5",
+        "url": "https://docs.pybamm.org/en/v22.5/"
     },
     {
-        "version": "v22.4",
-        "url": "https://pybamm.readthedocs.io/en/v22.4/"
+        "name": "v22.4",
+        "version": "22.4",
+        "url": "https://docs.pybamm.org/en/v22.4/"
     },
     {
-        "version": "v22.3",
-        "url": "https://pybamm.readthedocs.io/en/v22.3/"
+        "name": "v22.3",
+        "version": "22.3",
+        "url": "https://docs.pybamm.org/en/v22.3/"
     },
     {
-        "version": "v22.2",
-        "url": "https://pybamm.readthedocs.io/en/v22.3/"
+        "name": "v22.2",
+        "version": "22.2",
+        "url": "https://docs.pybamm.org/en/v22.3/"
     },
     {
-        "version": "v22.1",
-        "url": "https://pybamm.readthedocs.io/en/v22.1/"
+        "name": "v22.1",
+        "version": "22.1",
+        "url": "https://docs.pybamm.org/en/v22.1/"
     },
     {
-        "version": "v21.12",
-        "url": "https://pybamm.readthedocs.io/en/v21.12/"
+        "name": "v21.12",
+        "version": "21.12",
+        "url": "https://docs.pybamm.org/en/v21.12/"
     },
     {
-        "version": "v21.11",
-        "url": "https://pybamm.readthedocs.io/en/v21.11/"
+        "name": "v21.11",
+        "version": "21.11",
+        "url": "https://docs.pybamm.org/en/v21.11/"
     },
     {
-        "version": "v21.10",
-        "url": "https://pybamm.readthedocs.io/en/v21.10/"
+        "name": "v21.10",
+        "version": "21.10",
+        "url": "https://docs.pybamm.org/en/v21.10/"
     },
     {
-        "version": "v21.9",
-        "url": "https://pybamm.readthedocs.io/en/v21.9/"
+        "name": "v21.9",
+        "version": "21.9",
+        "url": "https://docs.pybamm.org/en/v21.9/"
     },
     {
-        "version": "v21.08",
-        "url": "https://pybamm.readthedocs.io/en/v21.08/"
+        "name": "v21.08",
+        "version": "21.08",
+        "url": "https://docs.pybamm.org/en/v21.08/"
     },
     {
-        "version": "v0.4.0",
-        "url": "https://pybamm.readthedocs.io/en/v0.4.0/"
+        "name": "v0.4.0",
+        "version": "0.4.0",
+        "url": "https://docs.pybamm.org/en/v0.4.0/"
     },
     {
-        "version": "v0.3.0",
-        "url": "https://pybamm.readthedocs.io/en/v0.3.0/"
+        "name": "v0.3.0",
+        "version": "0.3.0",
+        "url": "https://docs.pybamm.org/en/v0.3.0/"
     },
     {
-        "version": "v0.2.3",
-        "url": "https://pybamm.readthedocs.io/en/v0.2.3/"
+        "name": "v0.2.3",
+        "version": "0.2.3",
+        "url": "https://docs.pybamm.org/en/v0.2.3/"
     },
     {
-        "version": "v0.2.2",
-        "url": "https://pybamm.readthedocs.io/en/v0.2.2/"
+        "name": "v0.2.2",
+        "version": "0.2.2",
+        "url": "https://docs.pybamm.org/en/v0.2.2/"
     },
     {
-        "version": "v0.2.1",
-        "url": "https://pybamm.readthedocs.io/en/v0.2.1/"
+        "name": "v0.2.1",
+        "version": "0.2.1",
+        "url": "https://docs.pybamm.org/en/v0.2.1/"
     },
     {
-        "version": "v0.2.0",
-        "url": "https://pybamm.readthedocs.io/en/v0.2.0/"
+        "name": "v0.2.0",
+        "version": "0.2.0",
+        "url": "https://docs.pybamm.org/en/v0.2.0/"
     },
     {
-        "version": "v0.1.0",
-        "url": "https://pybamm.readthedocs.io/en/v0.1.0/"
+        "name": "v0.1.0",
+        "version": "0.1.0",
+        "url": "https://docs.pybamm.org/en/v0.1.0/"
     }
-]
+]
diff --git a/scripts/update_version.py b/scripts/update_version.py
@@ -50,10 +50,11 @@ def update_version():
         json_data.insert(
             2,
             {
-                "version": f"v{release_version}",
-                "url": f"https://pybamm.readthedocs.io/en/v{release_version}/",
+                "name": f"v{release_version}",
+                "version": f"{release_version}",
+                "url": f"https://docs.pybamm.org/en/v{release_version}/",
             },
-        )  # noqa: E501
+        )
         file.truncate(0)
         file.seek(0)
         file.write(json.dumps(json_data, indent=4))