From 02dd6d550e274be146d33d856b29da7e3ff8da7d Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Tue, 12 Nov 2024 18:23:17 +0100 Subject: [PATCH] Docs: disable `sphinx-hoverxref` in our docs We are going to start using the new addon link previews. --- docs/conf.py | 28 ---------------------------- requirements/docs.in | 1 - requirements/docs.txt | 7 +------ 3 files changed, 1 insertion(+), 35 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 87d59668433..dde0a808739 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,6 @@ sys.path.append(os.path.abspath("_ext")) extensions = [ - "hoverxref.extension", "multiproject", "myst_parser", # For testing, conditionally disable the custom 404 pages on dev docs @@ -124,14 +123,6 @@ myst_enable_extensions = [ "deflist", ] -hoverxref_intersphinx = [ - "sphinx", - "pip", - "nbsphinx", - "myst-nb", - "ipywidgets", - "jupytext", -] htmlhelp_basename = "ReadTheDocsdoc" latex_documents = [ ( @@ -181,25 +172,6 @@ "plausible_domain": f"{os.environ.get('READTHEDOCS_PROJECT')}.readthedocs.io", } -hoverxref_auto_ref = True -hoverxref_domains = ["py"] -hoverxref_roles = [ - "option", - # Documentation pages - # Not supported yet: https://github.com/readthedocs/sphinx-hoverxref/issues/18 - "doc", - # Glossary terms - "term", -] -hoverxref_role_types = { - "mod": "modal", # for Python Sphinx Domain - "doc": "modal", # for whole docs - "class": "tooltip", # for Python Sphinx Domain - "ref": "tooltip", # for hoverxref_auto_ref config - "confval": "tooltip", # for custom object - "term": "tooltip", # for glossaries -} - # See dev/style_guide.rst for documentation rst_epilog = """ .. |org_brand| replace:: Read the Docs Community diff --git a/requirements/docs.in b/requirements/docs.in index eae08693604..5aec1c19b6a 100644 --- a/requirements/docs.in +++ b/requirements/docs.in @@ -11,7 +11,6 @@ sphinx-design sphinx-multiproject # RTD deps :) -sphinx-hoverxref sphinx-notfound-page # Docs diff --git a/requirements/docs.txt b/requirements/docs.txt index 8e6fb609f0c..8945b2ea20e 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -110,7 +110,6 @@ sphinx==8.1.3 # sphinx-autobuild # sphinx-copybutton # sphinx-design - # sphinx-hoverxref # sphinx-intl # sphinx-notfound-page # sphinx-prompt @@ -126,8 +125,6 @@ sphinx-copybutton==0.5.2 # via -r requirements/docs.in sphinx-design==0.6.1 # via -r requirements/docs.in -sphinx-hoverxref==1.4.1 - # via -r requirements/docs.in sphinx-intl==2.2.0 # via -r requirements/docs.in sphinx-multiproject==1.0.0 @@ -149,9 +146,7 @@ sphinxcontrib-htmlhelp==2.1.0 sphinxcontrib-httpdomain==1.8.1 # via -r requirements/docs.in sphinxcontrib-jquery==4.1 - # via - # sphinx-hoverxref - # sphinx-rtd-theme + # via sphinx-rtd-theme sphinxcontrib-jsmath==1.0.1 # via sphinx sphinxcontrib-qthelp==2.0.0