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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcaa3cef5c090e94c6706bf4306f17160472240e83430246fd2729141ab55a52 |
|
MD5 | c56387858c1b0e43387ed77951b8a6a7 |
|
BLAKE2b-256 | d578c00662f284b78f49a809b3581ce4b722e4e4c53c633b0ffc4d556c1568c9 |
Hashes for sphinx_codeautolink-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1782029ad9f7ca07c716cb5de5b3a2f8a3f1a8e64538830cfd4755d0d09a664d |
|
MD5 | 0920ef263f1b30c8cc92a301a21ffa00 |
|
BLAKE2b-256 | f4cb735ebf49d6bf09296318cf4e2f5be8ecb67a3f730b9d75cd1989a4337c8b |