From 67b414f1e2605f86c7631a62a08cdcc4086f683d Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 21 Sep 2024 15:35:02 +0200 Subject: [PATCH 1/2] Use `sphinx-build-compatibility` to Keep Sphinx Compatibility --- docs/requirements-docs.txt | 4 +++- docs/source/conf.py | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 7c3a4239807..2c79d08500a 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -4,4 +4,6 @@ furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0. sphinx-paramlinks==0.6.0 sphinxcontrib-mermaid==0.9.2 sphinx-copybutton==0.5.2 -sphinx-inline-tabs==2023.4.21 \ No newline at end of file +sphinx-inline-tabs==2023.4.21 +# Temporary. See #4387 +sphinx-build-compatibility @ git+https://github.com/readthedocs/sphinx-build-compatibility.git@58aabc5f207c6c2421f23d3578adc0b14af57047 diff --git a/docs/source/conf.py b/docs/source/conf.py index abad78812c6..17095d41184 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -45,6 +45,8 @@ "sphinx_copybutton", "sphinx_inline_tabs", "sphinxcontrib.mermaid", + # Temporary. See #4387 + "sphinx_build_compatibility.extension", "sphinx_search.extension", ] From c0f20dbf4c3316183cc7c92dcf729eb020f06ac9 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 21 Sep 2024 15:54:26 +0200 Subject: [PATCH 2/2] Use extension only in RTD build --- docs/source/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 17095d41184..649ec68c287 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -45,11 +45,13 @@ "sphinx_copybutton", "sphinx_inline_tabs", "sphinxcontrib.mermaid", - # Temporary. See #4387 - "sphinx_build_compatibility.extension", "sphinx_search.extension", ] +# Temporary. See #4387 +if os.environ.get("READTHEDOCS", "") == "True": + extensions.append("sphinx_build_compatibility.extension") + # For shorter links to Wiki in docstrings extlinks = { "wiki": ("https://github.com/python-telegram-bot/python-telegram-bot/wiki/%s", "%s"),