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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fec2402805291cd5e0f47ea2f0ed75c4f3bd2ccd9c21a7985f30e1ab3a724cb |
|
MD5 | c029275c12de929a3cfada8f6beb834f |
|
BLAKE2b-256 | 63b094525ff1938de747c3e444a84e80daeedc1d064991cf6e718ccd2bdbc289 |
Hashes for sphinx_codeautolink-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8b8cbaf52ad353a3f55593bd113cb56f65949195028407c0d5bc0031bc0371a |
|
MD5 | 9014228072ff4facb526905d42faac4f |
|
BLAKE2b-256 | 998da61c20e1caaee15fc473f8e0edfa129940def20e50bf618e317755d1f1f9 |