Skip to main content

Automatic links from code examples to reference documentation.

Project description

Python versions Monthly downloads License: MIT Documentation

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_codeautolink-0.17.4.tar.gz (60.3 kB view details)

Uploaded Source

Built Distribution

sphinx_codeautolink-0.17.4-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page