Automatic links from code examples to reference documentation.
Project description
Automatic links from Python code examples to reference documentation at the flick of a switch! sphinx-codeautolink analyses the code in your documentation and inserts links to definitions that you use.
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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cab7c83ee25b5b509215451710bdbeeb450ca10576c28e1387a75a09cbae5fb |
|
MD5 | e2c4824913125b2f3cdc7c6e43823262 |
|
BLAKE2b-256 | 32e4d5a7c163477d0d9100365e9bc262db94a8a3a105f16076e02e33471720a0 |
Hashes for sphinx_codeautolink-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 100eaae2010c50bee849b39f64ccf5b07be1df5e711abcb62226521c933272d0 |
|
MD5 | 23ac3777115d826474755a2847e21f90 |
|
BLAKE2b-256 | e7336917cd52598c6c40e287fbb7f877fe75d10948a84d7b7f40f643f389a561 |