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
# or, alternatively:
$ 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 multiple examples and setting default import statements among other things, have a look at the online documentation.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.19.0)

1 maintainer

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

Credits

Author/Maintainer: =?utf-8?q?Felix_Hild=C3=A9n?=

License

MIT

Requires

Python >=3.6

Tags

sphinx extension code link

Classifiers

Report project as malware

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.12.1.tar.gz (47.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_codeautolink-0.12.1-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-codeautolink-0.12.1.tar.gz.

File metadata

  • Download URL: sphinx-codeautolink-0.12.1.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for sphinx-codeautolink-0.12.1.tar.gz
Algorithm Hash digest
SHA256 bef5c0fd4dcb78fe7899883f36666572dddb4f7012c508279f01a03f91a55b06
MD5 cc8ca9da7ab7afbf0a92c2fab9c0b0bf
BLAKE2b-256 a828f0c7d9abe494891efd7d61d1d2c9484026ac1a8bb1dddf09f26a30fcf019

See more details on using hashes here.

File details

Details for the file sphinx_codeautolink-0.12.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_codeautolink-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 99a1300867d3dba555c19a402269606df0fd4700254565ab5a133eb2cf38bfae
MD5 89899e3693da816b18838a9e5fa6f9c6
BLAKE2b-256 18d067602d5370708a87017d9caedfe60dab5a913bac2274880a4d2ed5525a32

See more details on using hashes here.

Release history Release notifications | RSS feed

0.19.0

2 files

0.18.1

2 files

0.18.0

2 files

0.17.5

2 files

0.17.4

2 files

0.17.3

2 files

0.17.2

2 files

0.17.1

2 files

0.17.0

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.2

2 files

0.15.1

2 files

0.15.0

2 files

0.14.1

2 files

0.14.0

2 files

0.13.2

2 files

0.13.1

2 files

0.13.0

2 files

This release

0.12.1 This release

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

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