Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: disable sphinx-hoverxref in our docs #11762

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Docs: disable sphinx-hoverxref in our docs #11762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -124,14 +123,6 @@
myst_enable_extensions = [
"deflist",
]
hoverxref_intersphinx = [
"sphinx",
"pip",
"nbsphinx",
"myst-nb",
"ipywidgets",
"jupytext",
]
htmlhelp_basename = "ReadTheDocsdoc"
latex_documents = [
(
Expand Down Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion requirements/docs.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ sphinx-design
sphinx-multiproject

# RTD deps :)
sphinx-hoverxref
sphinx-notfound-page

# Docs
Expand Down
7 changes: 1 addition & 6 deletions requirements/docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ sphinx==8.1.3
# sphinx-autobuild
# sphinx-copybutton
# sphinx-design
# sphinx-hoverxref
# sphinx-intl
# sphinx-notfound-page
# sphinx-prompt
Expand All @@ -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
Expand All @@ -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
Expand Down
Loading