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.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 079cc52400026a6298fd7e69033acf695ab605ab1adf8b91441c9fe8a871ae79 |
|
MD5 | 1bd5ea7619bda3b6ca86e6d898e7b8e2 |
|
BLAKE2b-256 | 8034c1231336ddebf9de6c9332a528c3736a8393bde8b5f230609cb165316995 |
Hashes for sphinx_codeautolink-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d3012d2150373bf3db3ae49006c46f06429c5205899425cfdcfc08209c7a126 |
|
MD5 | 83c7b83a8703a9bc621fe8b274cca6ab |
|
BLAKE2b-256 | 132f015f84fdf733562ef002d2c39c878b857035e70e0eef18d865c2d6fd5f67 |