Intersphinx with mkdocstrings¶
Use the feature
Cross-references to other projects / inventories
from mkdocstrings
to point directly to documentation objects.
The source project is built using Sphinx and, the destination project is built using MkDocs + mkdocstrings” plugin. Full documentation of mkdocstrings” plugin at: https://mkdocstrings.github.io/
Examples:
Sphinx configuration file used to build this docs (see full file),
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | # Default settings project = 'Test Builds' extensions = [ 'sphinx_autorun', 'sphinx.ext.intersphinx', ] latex_engine = 'xelatex' # allow us to build Unicode chars # Include all your settings here html_theme = 'sphinx_rtd_theme' intersphinx_mapping = { 'mkdocstrings': ('https://mkdocstrings.github.io/', None) } |
>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow() # UTC
datetime.datetime(2022, 8, 31, 14, 40, 34, 733576)