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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2db8ca030bc776f91da58a93ae8677090e70ea0a637d1a160be6062aaf290124 |
|
MD5 | 12ff493a4c0a032bdc8fd8f993b89202 |
|
BLAKE2b-256 | 26e9eb37b5339d48d36c5139432082f0f1b446ea5fa76dc2074273052de6f788 |
Hashes for sphinx_codeautolink-0.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2113eed8db9c62a6a9758bfdd1c1194020db66b68e6c7c775f642acf2a5e979 |
|
MD5 | 85e6d524d861731d7c3b3f58beb0d291 |
|
BLAKE2b-256 | f8973c1dc5439094a1bee49e1b5efd5d69c16117f03fe494435effd11fddf3a1 |