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.12.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bef5c0fd4dcb78fe7899883f36666572dddb4f7012c508279f01a03f91a55b06 |
|
MD5 | cc8ca9da7ab7afbf0a92c2fab9c0b0bf |
|
BLAKE2b-256 | a828f0c7d9abe494891efd7d61d1d2c9484026ac1a8bb1dddf09f26a30fcf019 |
Hashes for sphinx_codeautolink-0.12.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99a1300867d3dba555c19a402269606df0fd4700254565ab5a133eb2cf38bfae |
|
MD5 | 89899e3693da816b18838a9e5fa6f9c6 |
|
BLAKE2b-256 | 18d067602d5370708a87017d9caedfe60dab5a913bac2274880a4d2ed5525a32 |