sphinx-inlinecode is a Sphinx extension that embeds source code blocks directly into your documentation as a dropdown.
Example
Unlike sphinx.ext.viewcode, source code blocks will also be added for property and cached_property entries
Installation
To install sphinx-inlinecode via pip:
pip install sphinx-inlinecode
Configuration
Add the extension to your conf.py
extensions = [
"sphinx_inlinecode",
]
Documentation
Full documentation can be found on ReadTheDocs
Metadata
Release files for sphinx-inlinecode 2.0.1
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-inlinecode-2.0.1.tar.gz | 6.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_inlinecode-2.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.0 kB
Release files / sphinx-inlinecode-2.0.1.tar.gz
| Download URL | sphinx-inlinecode-2.0.1.tar.gz |
|---|---|
| Size | 6.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
da819bea38c234d391439a5044be32ac30143ad996e5a8169049ae9a6314a1aa
|
|
BLAKE2b-256 checksum How to use checksums |
279d968cf751ddc6501be07810985ef9bf9d00d1797b5b6575ff8204452c16ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.1
|
Release files / sphinx_inlinecode-2.0.1-py3-none-any.whl
| Download URL | sphinx_inlinecode-2.0.1-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8ba1b5c8919a4527ee2b7fa01902b80cd0a79376c169787b7c9de74374cb5054
|
|
BLAKE2b-256 checksum How to use checksums |
14b7bc445111dc4b2d5204b9937215d7f14b78a156195dce25128d8bc11ffda5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.1
|