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# Default settings
2project = 'Test Builds'
3extensions = [
4 'sphinx_autorun',
5 'sphinx.ext.intersphinx',
6]
7
8latex_engine = 'xelatex' # allow us to build Unicode chars
9
10# Include all your settings here
11html_theme = 'sphinx_rtd_theme'
12intersphinx_mapping = {
13 'mkdocstrings': ('https://mkdocstrings.github.io/', None)
14}
15
16
17
18
>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow() # UTC
datetime.datetime(2022, 8, 31, 14, 40, 37, 184613)