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 following sources:
$ pip install sphinx-codeautolink
# or, alternatively:
$ conda install -c conda-forge 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.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d61dea15498926b903df2db0bc81fc45760e2104a37d4d2ae970b244b22839f |
|
MD5 | 4281e55be1e8f5d7c332206bbda890d5 |
|
BLAKE2b-256 | 749b8823a8ef29c7ff2d7420fcf68df1a6a8bd4d8687faf8915e62bda8700931 |
Hashes for sphinx_codeautolink-0.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd64f8828a3007c4832178b23050a06f90e0148dd1bc5a64c1f56a8fd76d18aa |
|
MD5 | e31f2ce0844592e7d9c4ed2f81acfaad |
|
BLAKE2b-256 | 71d9e28f49fe45dd2eabc7f5f1e0d58a29acfcc42b82b49976b2bc7caa20d655 |