A Sphinx extension to embed source code blocks directly into documentation
Project description
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
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
File details
Details for the file sphinx-inlinecode-2.0.1.tar.gz.
File metadata
- Download URL: sphinx-inlinecode-2.0.1.tar.gz
- Upload date:
- Size: 6.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | da819bea38c234d391439a5044be32ac30143ad996e5a8169049ae9a6314a1aa |
|
| MD5 | 0d8bbee39984c592353336dd555a2d5a |
|
| BLAKE2b-256 | 279d968cf751ddc6501be07810985ef9bf9d00d1797b5b6575ff8204452c16ad |
File details
Details for the file sphinx_inlinecode-2.0.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_inlinecode-2.0.1-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8ba1b5c8919a4527ee2b7fa01902b80cd0a79376c169787b7c9de74374cb5054 |
|
| MD5 | 3e8414c636a312106cb352b6202d5980 |
|
| BLAKE2b-256 | 14b7bc445111dc4b2d5204b9937215d7f14b78a156195dce25128d8bc11ffda5 |
