sphinx-codeautolink
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-codeautolinkNote 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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-codeautolink 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-codeautolink-0.2.0.tar.gz | 27.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_codeautolink-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 44.5 kB
Release files / sphinx-codeautolink-0.2.0.tar.gz
| Download URL | sphinx-codeautolink-0.2.0.tar.gz |
|---|---|
| Size | 27.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ec66f289b9679f298b1aa009c94acfe6340555c291857791cce9ac9d3a1aa9c8
|
|
BLAKE2b-256 checksum How to use checksums |
b9e9aab8c5775aee13bb657562dd842b40fb56a88bc721613a40b85f99b1f170
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.4
|
Release files / sphinx_codeautolink-0.2.0-py3-none-any.whl
| Download URL | sphinx_codeautolink-0.2.0-py3-none-any.whl |
|---|---|
| Size | 17.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
42dfc7cb96729940e92ed736d612abff2a521389435588b27b6942e967debd67
|
|
BLAKE2b-256 checksum How to use checksums |
16ec74c69302f145360ba09b94ec809439373256b33e4f3719cdd921a8d9da17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.4
|
