From 8bc88361e9b594de3b64925eba943b7d086357ba Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 7 Oct 2024 08:13:46 +0000 Subject: [PATCH 1/3] Update sphinx-rtd-theme requirement from <3.0,>=1.0 to >=1.0,<4.0 Updates the requirements on [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) to permit the latest version. - [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst) - [Commits](https://github.com/readthedocs/sphinx_rtd_theme/compare/1.0.0...3.0.0) --- updated-dependencies: - dependency-name: sphinx-rtd-theme dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- docs/requirements-docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 6ba0747..d8cb763 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,5 +1,5 @@ # Requirements to build hpcss' documentation. sphinx >=5.0, <9.0 -sphinx-rtd-theme >=1.0, <3.0 +sphinx-rtd-theme >=1.0, <4.0 tomlkit >=0.1, < 1.0 From d28e37060425fad4b855ce83ef72cb15a55c50ad Mon Sep 17 00:00:00 2001 From: andthum <56444687+andthum@users.noreply.github.com> Date: Thu, 31 Oct 2024 12:48:30 +0100 Subject: [PATCH 2/3] [requirements-docs.txt]: Update sphinx-rtd-theme >=3.0, <4.0 Update sphinx-rtd-theme from `>=1.0, <4.0` to `>=3.0, <4.0`. In version 3.0.0, the configuration option [`display_version`](https://sphinx-rtd-theme.readthedocs.io/en/3.0.0/configuring.html#confval-display_version) was replaced by [`version_selector`](https://sphinx-rtd-theme.readthedocs.io/en/3.0.0/configuring.html#confval-version_selector). Note that [`version_selector`](https://sphinx-rtd-theme.readthedocs.io/en/3.0.0/configuring.html#confval-version_selector) requires the documentation to be hosted on [Read the Docs](https://readsthedocs.com/), because it makes use of [Read the Docs Addons](https://docs.readthedocs.io/page/addons.html). --- docs/requirements-docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index d8cb763..5677616 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,5 +1,5 @@ # Requirements to build hpcss' documentation. sphinx >=5.0, <9.0 -sphinx-rtd-theme >=1.0, <4.0 +sphinx-rtd-theme >=3.0, <4.0 tomlkit >=0.1, < 1.0 From 54d2ed05b6c74073217da54e50229c251993823a Mon Sep 17 00:00:00 2001 From: andthum <56444687+andthum@users.noreply.github.com> Date: Thu, 31 Oct 2024 12:51:09 +0100 Subject: [PATCH 3/3] [conf.py]: Update sphinx-rtd-theme Config Replace the deprecated option [`display_version`](https://sphinx-rtd-theme.readthedocs.io/en/3.0.0/configuring.html#confval-display_version) by [`version_selector`](https://sphinx-rtd-theme.readthedocs.io/en/3.0.0/configuring.html#confval-version_selector). --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 48b8f80..843a33c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -285,7 +285,7 @@ # the documentation of that theme. html_theme_options = { "logo_only": False, - "display_version": True, + "version_selector": True, "prev_next_buttons_location": "both", # Table-of-contents options. "collapse_navigation": True,