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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec66f289b9679f298b1aa009c94acfe6340555c291857791cce9ac9d3a1aa9c8 |
|
MD5 | 751e5dd2b823813d14ebb34011fcb945 |
|
BLAKE2b-256 | b9e9aab8c5775aee13bb657562dd842b40fb56a88bc721613a40b85f99b1f170 |
Hashes for sphinx_codeautolink-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42dfc7cb96729940e92ed736d612abff2a521389435588b27b6942e967debd67 |
|
MD5 | c2f1879fa2caffc2f682f2d48509fb18 |
|
BLAKE2b-256 | 16ec74c69302f145360ba09b94ec809439373256b33e4f3719cdd921a8d9da17 |