sphinx-codeautolink makes code examples clickable by inserting links from individual code elements to the corresponding reference documentation. We aim for a minimal setup assuming your examples are already valid Python.
For a live demo, see our online documentation on Read The Docs.
sphinx-codeautolink elsewhere:
sphinx-codeautolink can be installed from the following sources:
$ pip install sphinx-codeautolink
$ conda install -c conda-forge sphinx-codeautolinkTo enable sphinx-codeautolink, modify the extension list in conf.py.
Note that the extension name uses an underscore rather than a hyphen.
extensions = [
...,
"sphinx_codeautolink",
]That's it! Now your code examples are linked. For ways of concatenating examples, setting default import statements, or customising link style among other things, see the online documentation.
