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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e6ccf076d8eb5cf2aebcbcc3b36b6bbc7bb85938b55547a37c93affeff6ca3e |
|
MD5 | d69c9ee6f3cd4bf24096df43d59cb30f |
|
BLAKE2b-256 | 669056ecef2cfc02a5c384b4573f317587bb393ee2bfe7e899fc96014531fec3 |
Hashes for sphinx_codeautolink-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 983aa3885b686f417de0d03628da435d9a6a122858587cecadf8dcb61cf44f91 |
|
MD5 | 6c32906ce1ec3190adc319b425e8c714 |
|
BLAKE2b-256 | 061eba08278d90d22f5a14bf5cf0d95c05442024e12da64d2679a7c8ddeee007 |