diff --git a/.github/release_workflow.md b/.github/release_workflow.md index 8a032b9f9a..690f7fa407 100644 --- a/.github/release_workflow.md +++ b/.github/release_workflow.md @@ -11,7 +11,6 @@ This file contains the workflow required to make a `PyBaMM` release on GitHub, P - `CITATION.cff` - `pyproject.toml` - `vcpkg.json` - - `docs/_static/versions.json` - `CHANGELOG.md` These changes will be automatically pushed to a new branch `vYY.MM` and a PR from `vvYY.MM` to `develop` will be created (to sync the branches). @@ -35,7 +34,6 @@ If a new release candidate is required after the release of `rc0` - - `CITATION.cff` - `pyproject.toml` - `vcpkg.json` - - `docs/_static/versions.json` - `CHANGELOG.md` These changes will be automatically pushed to the existing `vYY.MM` branch and a PR from `vvYY.MM` to `develop` will be created (to sync the branches). @@ -57,7 +55,6 @@ Once satisfied with the release candidates - - `CITATION.cff` - `pyproject.toml` - `vcpkg.json` - - `docs/_static/versions.json` - `CHANGELOG.md` These changes will be automatically pushed to the existing `vYY.MM` branch and a PR from `vvYY.MM` to `develop` will be created (to sync the branches). @@ -74,7 +71,6 @@ Some other essential things to check throughout the release process - - If updating our custom vcpkg registory entries [pybamm-team/sundials-vcpkg-registry](https://github.com/pybamm-team/sundials-vcpkg-registry) or [pybamm-team/casadi-vcpkg-registry](https://github.com/pybamm-team/casadi-vcpkg-registry) (used to build Windows wheels), make sure to update the baseline of the registories in vcpkg-configuration.json to the latest commit id. - Update jax and jaxlib to the latest version in `pybamm.util` and `pyproject.toml`, fixing any bugs that arise -- Make sure the URLs in `docs/_static/versions.json` are valid - As the release workflow is initiated by the `release` event, it's important to note that the default `GITHUB_REF` used by `actions/checkout` during the checkout process will correspond to the tag created during the release process. Consequently, the workflows will consistently build PyBaMM based on the commit associated with this tag. Should new commits be introduced to the `vYY.MM` branch, such as those addressing build issues, it becomes necessary to manually update this tag to point to the most recent commit - ``` git tag -f diff --git a/.gitignore b/.gitignore index 3e01fcac83..612dc777b1 100644 --- a/.gitignore +++ b/.gitignore @@ -138,6 +138,7 @@ results/ # do not ignore images in _static folder in docs !docs/_static/favicon/favicon.png !docs/_static/pybamm_logo.png +!docs/_static/pybamm_logo_whitetext.png # tests test_callback.log diff --git a/docs/_static/pybamm_logo_whitetext.png b/docs/_static/pybamm_logo_whitetext.png new file mode 100644 index 0000000000..3ee7159ed4 Binary files /dev/null and b/docs/_static/pybamm_logo_whitetext.png differ diff --git a/docs/_static/versions.json b/docs/_static/versions.json deleted file mode 100644 index 675ecbcf88..0000000000 --- a/docs/_static/versions.json +++ /dev/null @@ -1,172 +0,0 @@ -[ - { - "name": "latest", - "version": "latest", - "url": "https://docs.pybamm.org/en/latest/" - }, - { - "name": "stable", - "version": "stable", - "url": "https://docs.pybamm.org/en/stable/" - }, - { - "name": "v23.9", - "version": "23.9", - "url": "https://docs.pybamm.org/en/v23.9_a/" - }, - { - "name": "v23.5", - "version": "23.5", - "url": "https://docs.pybamm.org/en/v23.5_a/" - }, - { - "name": "v23.4.1", - "version": "23.4.1", - "url": "https://docs.pybamm.org/en/v23.4.1/" - }, - { - "name": "v23.4", - "version": "23.4", - "url": "https://docs.pybamm.org/en/v23.4/" - }, - { - "name": "v23.3", - "version": "23.3", - "url": "https://docs.pybamm.org/en/v23.3/" - }, - { - "name": "v23.2", - "version": "23.2", - "url": "https://docs.pybamm.org/en/v23.2/" - }, - { - "name": "v23.1", - "version": "23.1", - "url": "https://docs.pybamm.org/en/v23.1/" - }, - { - "name": "v22.12", - "version": "22.12", - "url": "https://docs.pybamm.org/en/v22.12/" - }, - { - "name": "v22.11.1", - "version": "22.11.1", - "url": "https://docs.pybamm.org/en/v22.11.1/" - }, - { - "name": "v22.11", - "version": "22.11", - "url": "https://docs.pybamm.org/en/v22.11/" - }, - { - "name": "v22.10", - "version": "22.10", - "url": "https://docs.pybamm.org/en/v22.10/" - }, - { - "name": "v22.9", - "version": "22.9", - "url": "https://docs.pybamm.org/en/v22.9/" - }, - { - "name": "v22.8", - "version": "22.8", - "url": "https://docs.pybamm.org/en/v22.8/" - }, - { - "name": "v22.7", - "version": "22.7", - "url": "https://docs.pybamm.org/en/v22.7/" - }, - { - "name": "v22.6", - "version": "22.6", - "url": "https://docs.pybamm.org/en/v22.6/" - }, - { - "name": "v22.5", - "version": "22.5", - "url": "https://docs.pybamm.org/en/v22.5/" - }, - { - "name": "v22.4", - "version": "22.4", - "url": "https://docs.pybamm.org/en/v22.4/" - }, - { - "name": "v22.3", - "version": "22.3", - "url": "https://docs.pybamm.org/en/v22.3/" - }, - { - "name": "v22.2", - "version": "22.2", - "url": "https://docs.pybamm.org/en/v22.3/" - }, - { - "name": "v22.1", - "version": "22.1", - "url": "https://docs.pybamm.org/en/v22.1/" - }, - { - "name": "v21.12", - "version": "21.12", - "url": "https://docs.pybamm.org/en/v21.12/" - }, - { - "name": "v21.11", - "version": "21.11", - "url": "https://docs.pybamm.org/en/v21.11/" - }, - { - "name": "v21.10", - "version": "21.10", - "url": "https://docs.pybamm.org/en/v21.10/" - }, - { - "name": "v21.9", - "version": "21.9", - "url": "https://docs.pybamm.org/en/v21.9/" - }, - { - "name": "v21.08", - "version": "21.08", - "url": "https://docs.pybamm.org/en/v21.08/" - }, - { - "name": "v0.4.0", - "version": "0.4.0", - "url": "https://docs.pybamm.org/en/v0.4.0/" - }, - { - "name": "v0.3.0", - "version": "0.3.0", - "url": "https://docs.pybamm.org/en/v0.3.0/" - }, - { - "name": "v0.2.3", - "version": "0.2.3", - "url": "https://docs.pybamm.org/en/v0.2.3/" - }, - { - "name": "v0.2.2", - "version": "0.2.2", - "url": "https://docs.pybamm.org/en/v0.2.2/" - }, - { - "name": "v0.2.1", - "version": "0.2.1", - "url": "https://docs.pybamm.org/en/v0.2.1/" - }, - { - "name": "v0.2.0", - "version": "0.2.0", - "url": "https://docs.pybamm.org/en/v0.2.0/" - }, - { - "name": "v0.1.0", - "version": "0.1.0", - "url": "https://docs.pybamm.org/en/v0.1.0/" - } -] diff --git a/docs/conf.py b/docs/conf.py index 49e5cf3dc9..40074848a1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -122,7 +122,7 @@ html_theme_options = { "logo": { "image_light": "pybamm_logo.png", - "image_dark": "pybamm_logo.png", + "image_dark": "pybamm_log_whitetext.png", }, "icon_links": [ { @@ -142,11 +142,6 @@ }, ], "collapse_navigation": True, - # should be kept versioned to use for the version warning bar - "switcher": { - "version_match": version, - "json_url": "https://docs.pybamm.org/en/latest/_static/versions.json", - }, # turn to False to not fail build if json_url is not found "check_switcher": True, # for dark mode toggle and social media links diff --git a/scripts/update_version.py b/scripts/update_version.py index 8a2d832e59..ab8a9345ba 100644 --- a/scripts/update_version.py +++ b/scripts/update_version.py @@ -48,26 +48,6 @@ def update_version(): file.seek(0) file.write(replace_version) - # docs/_static/versions.json for readthedocs build - if "rc" not in release_version: - with open( - os.path.join(pybamm.root_dir(), "docs", "_static", "versions.json"), - "r+", - ) as file: - output = file.read() - json_data = json.loads(output) - json_data.insert( - 2, - { - "name": f"v{release_version}", - "version": f"{release_version}", - "url": f"https://docs.pybamm.org/en/v{release_version}/", - }, - ) - file.truncate(0) - file.seek(0) - file.write(json.dumps(json_data, indent=4)) - # vcpkg.json with open(os.path.join(pybamm.root_dir(), "vcpkg.json"), "r+") as file: output = file.read()