Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure versions.json and remove the version switcher dropdown #3108

Merged
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
version = pybamm.__version__
# The full version, including alpha/beta/rc tags
release = version
# Load the latest version by default
dropdown_version = "latest"


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -146,8 +148,8 @@
},
],
"switcher": {
"version_match": release,
"json_url": "https://pybamm.readthedocs.io/en/latest/_static/versions.json", # noqa: E501
"version_match": dropdown_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,
Expand Down
6 changes: 3 additions & 3 deletions docs/source/_static/pybamm.css
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,20 @@ Nat Methods 8, 441 (2011). https://doi.org/10.1038/nmeth.1618
*/

/* If the active version has the name "latest", style it orange */
.version-switcher__button[data-active-version-name*="latest"] {
.version-switcher__container a[data-active-version-name*="latest"] {
background-color: #e69f00;
border-color: #e69f00;
color: #000000;
}

/* green for `stable` */
.version-switcher__button[data-active-version-name*="stable"] {
.version-switcher__container a[data-active-version-name*="stable"] {
background-color: #009e73;
border-color: #009e73;
}

/* red for `old` */
.version-switcher__button:not(
.version-switcher__container a:not(
[data-active-version-name*="latest"],
[data-active-version-name*="stable"]
) {
Expand Down
66 changes: 33 additions & 33 deletions docs/source/_static/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,135 +2,135 @@
{
"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/"
"url": "https://docs.pybamm.org/en/v23.5_a/"
},
{
"version": "v23.4.1",
"url": "https://pybamm.readthedocs.io/en/v23.4.1/"
"url": "https://docs.pybamm.org/en/v23.4.1/"
},
{
"version": "v23.4",
"url": "https://pybamm.readthedocs.io/en/v23.4/"
"url": "https://docs.pybamm.org/en/v23.4/"
},
{
"version": "v23.3",
"url": "https://pybamm.readthedocs.io/en/v23.3/"
"url": "https://docs.pybamm.org/en/v23.3/"
},
{
"version": "v23.2",
"url": "https://pybamm.readthedocs.io/en/v23.2/"
"url": "https://docs.pybamm.org/en/v23.2/"
},
{
"version": "v23.1",
"url": "https://pybamm.readthedocs.io/en/v23.1/"
"url": "https://docs.pybamm.org/en/v23.1/"
},
{
"version": "v22.12",
"url": "https://pybamm.readthedocs.io/en/v22.12/"
"url": "https://docs.pybamm.org/en/v22.12/"
},
{
"version": "v22.11.1",
"url": "https://pybamm.readthedocs.io/en/v22.11.1/"
"url": "https://docs.pybamm.org/en/v22.11.1/"
},
{
"version": "v22.11",
"url": "https://pybamm.readthedocs.io/en/v22.11/"
"url": "https://docs.pybamm.org/en/v22.11/"
},
{
"version": "v22.10",
"url": "https://pybamm.readthedocs.io/en/v22.10/"
"url": "https://docs.pybamm.org/en/v22.10/"
},
{
"version": "v22.9",
"url": "https://pybamm.readthedocs.io/en/v22.9/"
"url": "https://docs.pybamm.org/en/v22.9/"
},
{
"version": "v22.8",
"url": "https://pybamm.readthedocs.io/en/v22.8/"
"url": "https://docs.pybamm.org/en/v22.8/"
},
{
"version": "v22.7",
"url": "https://pybamm.readthedocs.io/en/v22.7/"
"url": "https://docs.pybamm.org/en/v22.7/"
},
{
"version": "v22.6",
"url": "https://pybamm.readthedocs.io/en/v22.6/"
"url": "https://docs.pybamm.org/en/v22.6/"
},
{
"version": "v22.5",
"url": "https://pybamm.readthedocs.io/en/v22.5/"
"url": "https://docs.pybamm.org/en/v22.5/"
},
{
"version": "v22.4",
"url": "https://pybamm.readthedocs.io/en/v22.4/"
"url": "https://docs.pybamm.org/en/v22.4/"
},
{
"version": "v22.3",
"url": "https://pybamm.readthedocs.io/en/v22.3/"
"url": "https://docs.pybamm.org/en/v22.3/"
},
{
"version": "v22.2",
"url": "https://pybamm.readthedocs.io/en/v22.3/"
"url": "https://docs.pybamm.org/en/v22.3/"
},
{
"version": "v22.1",
"url": "https://pybamm.readthedocs.io/en/v22.1/"
"url": "https://docs.pybamm.org/en/v22.1/"
},
{
"version": "v21.12",
"url": "https://pybamm.readthedocs.io/en/v21.12/"
"url": "https://docs.pybamm.org/en/v21.12/"
},
{
"version": "v21.11",
"url": "https://pybamm.readthedocs.io/en/v21.11/"
"url": "https://docs.pybamm.org/en/v21.11/"
},
{
"version": "v21.10",
"url": "https://pybamm.readthedocs.io/en/v21.10/"
"url": "https://docs.pybamm.org/en/v21.10/"
},
{
"version": "v21.9",
"url": "https://pybamm.readthedocs.io/en/v21.9/"
"url": "https://docs.pybamm.org/en/v21.9/"
},
{
"version": "v21.08",
"url": "https://pybamm.readthedocs.io/en/v21.08/"
"url": "https://docs.pybamm.org/en/v21.08/"
},
{
"version": "v0.4.0",
"url": "https://pybamm.readthedocs.io/en/v0.4.0/"
"url": "https://docs.pybamm.org/en/v0.4.0/"
},
{
"version": "v0.3.0",
"url": "https://pybamm.readthedocs.io/en/v0.3.0/"
"url": "https://docs.pybamm.org/en/v0.3.0/"
},
{
"version": "v0.2.3",
"url": "https://pybamm.readthedocs.io/en/v0.2.3/"
"url": "https://docs.pybamm.org/en/v0.2.3/"
},
{
"version": "v0.2.2",
"url": "https://pybamm.readthedocs.io/en/v0.2.2/"
"url": "https://docs.pybamm.org/en/v0.2.2/"
},
{
"version": "v0.2.1",
"url": "https://pybamm.readthedocs.io/en/v0.2.1/"
"url": "https://docs.pybamm.org/en/v0.2.1/"
},
{
"version": "v0.2.0",
"url": "https://pybamm.readthedocs.io/en/v0.2.0/"
"url": "https://docs.pybamm.org/en/v0.2.0/"
},
{
"version": "v0.1.0",
"url": "https://pybamm.readthedocs.io/en/v0.1.0/"
"url": "https://docs.pybamm.org/en/v0.1.0/"
}
]