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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d741bc554b3a5bfa43e863d963ca7a82815ca8f5940f9c13dcb9b0fba19163b4 |
|
MD5 | 386321ea558d3f5cd72335de20a11faa |
|
BLAKE2b-256 | 75a775ef9edbb94de18dcd86bbf1311014237817237a92d1a71727eaf955e718 |
Hashes for sphinx_codeautolink-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83e3b10beea1889fe226a3262271cc909a998f3e03e82da97d453c02251d347d |
|
MD5 | 224abfdf5a4a0e8991a6745a952e7784 |
|
BLAKE2b-256 | e4e6db4caccee055f9c48596ea3ead1c8098a74cc9edcb5aea89cc5dfdf40644 |