summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorManuel Kaufmann <humitos@gmail.com>2022-07-11 18:26:19 +0200
committerManuel Kaufmann <humitos@gmail.com>2022-07-13 12:31:48 +0200
commit2d2fe2ea26463e7d8f8f862695d646f14486bfdc (patch)
treed646c0678cac73f9b5503357a88254997d130ea3 /docs/conf.py
parent4d00d5091e0817f6e539c48f4afc2e69b8ac2591 (diff)
downloadpython-setuptools-git-2d2fe2ea26463e7d8f8f862695d646f14486bfdc.tar.gz
Docs: enable tooltips on documentation
Install the Sphinx extension `sphinx-hoverxref` to enable tooltips when hovering internal and external references (via intersphinx).
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index b7d05382..a5e44eae 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -102,6 +102,19 @@ intersphinx_mapping.update({
),
})
+# Support tooltips on references
+extensions += ['hoverxref.extension']
+hoverxref_auto_ref = True
+hoverxref_intersphinx = [
+ 'python',
+ 'pip',
+ 'build',
+ 'PyPUG',
+ 'packaging',
+ 'twine',
+ 'importlib-resources',
+]
+
# Add support for linking usernames
github_url = 'https://github.com'
github_repo_org = 'pypa'