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.13.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 020933a0a001b31996bcbdd9e77ae25b2122cb025e077a6326888d3fe72b7201 |
|
MD5 | 1921fd7997e24b646e7c177e171e0178 |
|
BLAKE2b-256 | 97cfd344d73a6f3bb4aeb4faa0ccd5d3ab1982327d12458043a13bea1e1ba55a |
Hashes for sphinx_codeautolink-0.13.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9921463ecac51aa1e59d81d4120ba0d72a2b170fa49c9d848a8465bf6464b497 |
|
MD5 | 578866956d1cb827f642a2388eabc892 |
|
BLAKE2b-256 | d43b4914f0fe6c5259f17d91830da9978aad58aefe67ae920eb76d9deda0fff1 |