sphinx-codeautolink

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.

Installation

sphinx-codeautolink can be installed from the following sources:

$ pip install sphinx-codeautolink
$ conda install -c conda-forge sphinx-codeautolink

Note that the library is in early development, so version pinning is advised. To 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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!