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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c19b17f17ef02952a43d7bee34c2859f4d4b71119f635618c8f224ac8e035f12 |
|
MD5 | d29e48bd4f98ce3f0e1384998866a2a0 |
|
BLAKE2b-256 | 871c1779a89b1dbdfa52610ebeb67925a2c4d757aa595d3e53f81fb4624d1b93 |
Hashes for sphinx_codeautolink-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14e9ec8bbbd188d6c527b735a3b5257b784cb8899af945325143421730174b88 |
|
MD5 | f1eb631f595ab8357b1c6265199fd394 |
|
BLAKE2b-256 | 163fe87f36139af8d2f431ba9cfad3043e62fba90831e35a2bbda33448d3b084 |