Automatic links from code examples to reference documentation.
Project description
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 details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx-codeautolink-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffd5cd833e11ace5dcf25c7f4132fd880cf2d26f0af59cb49799982d7b19dee5 |
|
MD5 | 59b1b68c559b08e867405b884f69eea1 |
|
BLAKE2b-256 | e34eb606791addcf197dcfec89286aa16008d0dd061ca48e6d3370a967c3dfff |
Hashes for sphinx_codeautolink-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 380ecdc03bd690383e97d80ed1cd50829a45eea63f7447277c07ab222c7237ca |
|
MD5 | 9ff36fd9e609dc9f0e59e999dc3e1351 |
|
BLAKE2b-256 | fe87cc1e88e9bd6da7a8c7403fe85f779f0c51521fa31e65e54ca8b5e29b515b |