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.15.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2db64a2012dbf1772f95638196ae4885a6849ddd3d44f594e4f8875bf7b73779 |
|
MD5 | 8bc7687a42b720e1d6462d4a4f18abc7 |
|
BLAKE2b-256 | 707ae1e21648b27d27cb33a96ee04fe44609706584b880583a1dabf84704bb03 |
Hashes for sphinx_codeautolink-0.15.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02a5c768bc1de5f8f8248c02fadc7be0e23370b4c265a2495c0a7c3f337e5d71 |
|
MD5 | 0874cd1ec8ed9e4add80753dd3f5456d |
|
BLAKE2b-256 | e026a78a0864c66091e5050b995aa867bf40e37de73467bcc5a48e3f88e19087 |