Python versions monthly downloads License: MIT documentation

Automatic links from Python code examples to reference documentation at the flick of a switch! sphinx-codeautolink analyses the code in your documentation and inserts links to definitions that you use.

For a live demo, see our online documentation on Read The Docs.

Installation

sphinx-codeautolink can be installed from the Package Index via pip.

$ pip install 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: Felix Hildén

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.1.1.tar.gz (21.1 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.1.1-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-codeautolink-0.1.1.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.4

File hashes

Hashes for sphinx-codeautolink-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3cab7c83ee25b5b509215451710bdbeeb450ca10576c28e1387a75a09cbae5fb
MD5 e2c4824913125b2f3cdc7c6e43823262
BLAKE2b-256 32e4d5a7c163477d0d9100365e9bc262db94a8a3a105f16076e02e33471720a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_codeautolink-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.4

File hashes

Hashes for sphinx_codeautolink-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 100eaae2010c50bee849b39f64ccf5b07be1df5e711abcb62226521c933272d0
MD5 23ac3777115d826474755a2847e21f90
BLAKE2b-256 e7336917cd52598c6c40e287fbb7f877fe75d10948a84d7b7f40f643f389a561

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

0.12.1

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

This release

0.1.1 This release

2 files

0.1.0

2 files

Supported by

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