diff --git a/poetry.lock b/poetry.lock index 89c5a9e..369e1ec 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. [[package]] name = "ablog" @@ -893,6 +893,22 @@ files = [ [package.dependencies] six = ">=1.5" +[[package]] +name = "readthedocs-sphinx-ext" +version = "2.2.5" +description = "Sphinx extension for Read the Docs overrides" +optional = false +python-versions = "*" +files = [ + {file = "readthedocs-sphinx-ext-2.2.5.tar.gz", hash = "sha256:ee5fd5b99db9f0c180b2396cbce528aa36671951b9526bb0272dbfce5517bd27"}, + {file = "readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl", hash = "sha256:f8c56184ea011c972dd45a90122568587cc85b0127bc9cf064d17c68bc809daa"}, +] + +[package.dependencies] +Jinja2 = ">=2.9" +packaging = "*" +requests = "*" + [[package]] name = "requests" version = "2.32.3" @@ -1036,15 +1052,13 @@ doc = ["sphinx-autoapi", "sphinx-rtd-theme", "sphinx-tabs", "sphinxemoji"] test = ["tox"] [[package]] -name = "sphinx-rtd-theme" -version = "2.0.0" +name = "sphinx_rtd_theme" +version = "2.0.1alpha1" description = "Read the Docs theme for Sphinx" optional = false python-versions = ">=3.6" -files = [ - {file = "sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl", hash = "sha256:ec93d0856dc280cf3aee9a4c9807c60e027c7f7b461b77aeffed682e68f0e586"}, - {file = "sphinx_rtd_theme-2.0.0.tar.gz", hash = "sha256:bd5d7b80622406762073a04ef8fadc5f9151261563d47027de09910ce03afe6b"}, -] +files = [] +develop = false [package.dependencies] docutils = "<0.21" @@ -1054,6 +1068,12 @@ sphinxcontrib-jquery = ">=4,<5" [package.extras] dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client", "wheel"] +[package.source] +type = "git" +url = "https://github.com/readthedocs/sphinx_rtd_theme.git" +reference = "357e76dc42a89c1c387cafd8cb134378a57e4d6d" +resolved_reference = "357e76dc42a89c1c387cafd8cb134378a57e4d6d" + [[package]] name = "sphinx-tabs" version = "3.4.5" @@ -1528,4 +1548,4 @@ test = ["pytest"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "86967fd3d953796629bd06eb1a82117dd97cdf21c30f57753901d709b0e5ef93" +content-hash = "8858431f58e38dfb1cbb975859e61370bf8235098e9612f5ec6a55b6dcd06350" diff --git a/pyproject.toml b/pyproject.toml index 672a60b..74189e1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,10 +12,11 @@ docutils = "==0.20.1" fonttools = {version = "==4.33.3", extras = ["woff"]} latex = "==0.7.0" packaging = "==24.1" +readthedocs-sphinx-ext = "^2" sphinx = "==7.3.7" +sphinx-rtd-theme = {git = "https://github.com/readthedocs/sphinx_rtd_theme.git", rev = "357e76dc42a89c1c387cafd8cb134378a57e4d6d"} sphinx-hoverxref = "==1.0.1" sphinx-notfound-page = "==1.0.2" -sphinx-rtd-theme = "==2.0.0" sphinx-tabs = "==3.4.5" sphinx-version-warning = "==1.1.2" sphinxcontrib-ghcontributors = "==0.2.3" diff --git a/source/conf.py b/source/conf.py index 690834c..5acb682 100644 --- a/source/conf.py +++ b/source/conf.py @@ -61,6 +61,7 @@ 'sphinx.ext.intersphinx', 'ablog', 'notfound.extension', + 'readthedocs_ext.readthedocs', 'sphinxext.opengraph', 'sphinx.ext.autosectionlabel' ] @@ -95,6 +96,7 @@ on_rtd = os.environ.get('READTHEDOCS') == 'True' if on_rtd: + html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") notfound_no_urls_prefix = False else: notfound_no_urls_prefix = True diff --git a/source/requirements.txt b/source/requirements.txt index 1271c18..a6cb58c 100644 --- a/source/requirements.txt +++ b/source/requirements.txt @@ -30,6 +30,7 @@ pbr==6.0.0 ; python_version >= "3.9" and python_version < "4.0" pycparser==2.22 ; platform_python_implementation != "CPython" and python_version >= "3.9" and python_version < "4.0" pygments==2.18.0 ; python_version >= "3.9" and python_version < "4.0" python-dateutil==2.9.0.post0 ; python_version >= "3.9" and python_version < "4.0" +readthedocs-sphinx-ext==2.2.5 ; python_version >= "3.9" and python_version < "4.0" requests==2.32.3 ; python_version >= "3.9" and python_version < "4.0" restructuredtext-lint==1.4.0 ; python_version >= "3.9" and python_version < "4.0" shutilwhich==1.1.0 ; python_version >= "3.9" and python_version < "4.0" @@ -38,7 +39,7 @@ smmap==5.0.1 ; python_version >= "3.9" and python_version < "4.0" snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "4.0" sphinx-hoverxref==1.0.1 ; python_version >= "3.9" and python_version < "4.0" sphinx-notfound-page==1.0.2 ; python_version >= "3.9" and python_version < "4.0" -sphinx-rtd-theme==2.0.0 ; python_version >= "3.9" and python_version < "4.0" +sphinx-rtd-theme @ git+https://github.com/readthedocs/sphinx_rtd_theme.git@357e76dc42a89c1c387cafd8cb134378a57e4d6d ; python_version >= "3.9" and python_version < "4.0" sphinx-tabs==3.4.5 ; python_version >= "3.9" and python_version < "4.0" sphinx-version-warning==1.1.2 ; python_version >= "3.9" and python_version < "4.0" sphinx==7.3.7 ; python_version >= "3.9" and python_version < "4.0"