Skip to content

Move away from hoverxrefs #3245

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

Merged
A5rocks merged 1 commit into from
Apr 21, 2025
Merged

Move away from hoverxrefs #3245

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
1 change: 0 additions & 1 deletion docs-requirements.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sphinx_rtd_theme >= 3
sphinxcontrib-jquery
sphinxcontrib-trio
towncrier
sphinx-hoverxref
sphinx-codeautolink

# Trio's own dependencies
Expand Down
4 changes: 0 additions & 4 deletions docs-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,11 @@ sphinx==8.2.3
# via
# -r docs-requirements.in
# sphinx-codeautolink
# sphinx-hoverxref
# sphinx-rtd-theme
# sphinxcontrib-jquery
# sphinxcontrib-trio
sphinx-codeautolink==0.17.4
# via -r docs-requirements.in
sphinx-hoverxref==1.4.2
# via -r docs-requirements.in
sphinx-rtd-theme==3.0.2
# via -r docs-requirements.in
sphinxcontrib-applehelp==2.0.0
Expand All @@ -92,7 +89,6 @@ sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jquery==4.1
# via
# -r docs-requirements.in
# sphinx-hoverxref
# sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
Expand Down
19 changes: 0 additions & 19 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,6 @@ def setup(app: Sphinx) -> None:
"sphinx.ext.napoleon",
"sphinxcontrib_trio",
"sphinxcontrib.jquery",
"hoverxref.extension",
"sphinx_codeautolink",
"local_customization",
"typevars",
Expand All @@ -248,24 +247,6 @@ def setup(app: Sphinx) -> None:
"flake8-async": ("https://flake8-async.readthedocs.io/en/latest/", None),
}

# See https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html
hoverxref_auto_ref = True
hoverxref_domains = ["py"]
# Set the default style (tooltip) for all types to silence logging.
# See https://github.com/readthedocs/sphinx-hoverxref/issues/211
hoverxref_role_types = {
"attr": "tooltip",
"class": "tooltip",
"const": "tooltip",
"exc": "tooltip",
"func": "tooltip",
"meth": "tooltip",
"mod": "tooltip",
"obj": "tooltip",
"ref": "tooltip",
"data": "tooltip",
}

# See https://sphinx-codeautolink.readthedocs.io/en/latest/reference.html#configuration
codeautolink_autodoc_inject = False
codeautolink_global_preface = """
Expand Down