From 6540f288f58566e9b29aa4cb6f1897200bfba6f4 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Thu, 31 Oct 2024 08:27:58 +0100 Subject: [PATCH] Use `sphinx-build-compatibility` to Keep Sphinx Compatibility (#4492) --- docs/requirements-docs.txt | 4 +++- docs/source/conf.py | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 1ae17a68f..ab62b8878 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==1.0.0 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 caac474d3..f54a3a4c7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,6 +48,10 @@ extensions = [ "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"),