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 links

Data verified by PyPI on Jul 29, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for felix-hilden from gravatar.com felix-hilden

Credits

Author/Maintainer: Felix Hildén

Requires

Python >=3.10

Provides Extra

ipython

Tags

sphinx extension code link

Classifiers

Report project as malware

Release files for sphinx-codeautolink 0.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-codeautolink 0.19.0
File Size Uploaded
sphinx_codeautolink-0.19.0.tar.gz 65.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-codeautolink 0.19.0
File Interpreter ABI Platform
sphinx_codeautolink-0.19.0-py3-none-any.whl 37.7 kB Python 3 none any Details

Total release size: 103.1 kB

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page