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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b15e91ddd9c959062b679e5b905e706bd9d0c52a1be6b51690a906279c7cf092 |
|
MD5 | 8651bd5735005c0d814fdd6cdfbdf16d |
|
BLAKE2b-256 | b9dfe2a4950dd3c9cb6903f86957cf7a2b862b9e257cb83c8b6235346c5e9d57 |
Hashes for sphinx_codeautolink-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 194574d7dfb84df32343cdde1029b35c3e90abc51d1784cd740181dfb7538366 |
|
MD5 | 4368033a04ca3d88412743f59bcba15b |
|
BLAKE2b-256 | c609894a0c218e17f71cd3d1a7699e4a85e322ef394561f2a88fc83e23245604 |