sphinx-hoverxref

Make usage of sphinx-hoverxref and test different scenarios.

Tooltips with issues on glossary

Example:

Reference to a title

conf.py

Reference to a document

conf.py

Read the Docs configuration file used to build this docs:

 1version: 2
 2
 3build:
 4  os: ubuntu-22.04
 5  tools:
 6    python: "3"
 7  apt_packages:
 8    - tree
 9  jobs:
10    pre_build:
11      - env
12
13sphinx:
14  configuration: docs/conf.py
15
16python:
17  install:
18    - requirements: requirements.txt

Sphinx configuration file used to build this docs (see full file),

 1import os
 2
 3# Default settings
 4project = 'Test Builds'
 5extensions = [
 6    'sphinx_autorun',
 7    'sphinx.ext.autosectionlabel',
 8    'hoverxref.extension',
 9]
10
11if "LOCAL_BUILD" in os.environ:
12    hoverxref_api_host = 'http://devthedocs.org'
13
14hoverxref_auto_ref = True
15hoverxref_roles = [
16    'term',
17]
18
19autosectionlabel_prefix_document = True
20
21latex_engine = 'xelatex'  # allow us to build Unicode chars
22
23
24# Include all your settings here
25html_theme = 'sphinx_rtd_theme'
26
27
28
29

>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow()  # UTC
datetime.datetime(2023, 2, 14, 16, 12, 4, 641710)

Contents

All contents of this documentation.