Automatic links from code examples to reference documentation.
Project description
sphinx-codeautolink makes code examples clickable by inserting links from individual code elements to the corresponding reference documentation. We aim for a minimal setup assuming your examples are already valid Python.
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.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd402b1105c9d46ce632874698dd1d3e7cde966fdcc0ebe88b9754aa5a38ff57 |
|
MD5 | 44a32eb3c2970326882df7b9725fbfef |
|
BLAKE2b-256 | 5fbc816e05e99aca119040d8bfc29321b6ff5690818f07c7d6609b8715b2b0d5 |
Hashes for sphinx_codeautolink-0.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb29a3b1ac1c7466e5d3b76f57558253f24cb7de0def119c59df3167a01ff678 |
|
MD5 | b0bb095a6fc00433ac71a2b7f8157d47 |
|
BLAKE2b-256 | c69500ee74a5a15399cd0c450e2cdc727e5f39710c20d4e0ac737c722705bb16 |