Automatic links from code examples to reference documentation.
Project description
sphinx-codeautolink makes code examples clickable by inserting links from individual code elements to the corresponding reference documentation. We aim for a minimal setup assuming your examples are already valid Python.
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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8af561077b2a0824241828757a442bbbc93e54fae792511e367a6c4c2b0bca73 |
|
MD5 | 3d60902847775855a609d0efe91a3f37 |
|
BLAKE2b-256 | def15aa5f5ab6bd9fba84dcfb7bd6b7a15a83188d3d2892d7deb2009c1814e12 |
Hashes for sphinx_codeautolink-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1fa3efba51b5cd3b376805155a007a507dd40dbb7dd944a82b251ea6f09c6a2 |
|
MD5 | dbb23ead2d726791d21e7196c204862e |
|
BLAKE2b-256 | 048776b8c65784aad9334db22bd19711987a20985a4bb8ca8d7b9dd8e285267d |