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.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3551e9787c8ff83171b230cefeb41a7dd386d0f71c23df8191e2587fa18362c0 |
|
MD5 | c3668b2e5068622de72c87a4c67553d9 |
|
BLAKE2b-256 | 609fbe611f8c8cd84d5429693a53874b6838544d5c37bdc8be21c21f17532b40 |
Hashes for sphinx_codeautolink-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d62bf2db03417af080214c58e78025ca9aa8c7463aa70776218fab56597fc78e |
|
MD5 | 5559a81ace54ab60699baf27eb028d1d |
|
BLAKE2b-256 | a250c0415686de4a6e4dfe729c4f3d19bcd512be4862bc352344f36ea7c4bdbf |