Sphinx' literalinclude, but without docstrings
Project description
undocinclude
Sphinx plugin that provides a directive undocinclude
, which is basically literalinclude
but hacked to omit docstrings.
Supports a subset of literalinclude
's options.
Installation
Add this package to your requirements, and modify your Sphinx conf.py
:
extensions = [
# ...
'undocinclude.extension',
# ...
]
Example
.. undocinclude:: /path/to/script.py
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
undocinclude-0.1.0.tar.gz
(5.8 kB
view hashes)
Built Distribution
Close
Hashes for undocinclude-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8968600ada22053bf27cb894766cb1178bdbdc7be487e18441ce110be4fa6c8c |
|
MD5 | b8bbff4bdd32efdc468e0125b3ca4014 |
|
BLAKE2b-256 | 852ffc42e179a838acf679a29a45aa9ff35222b9ab45e982f15fc58dfe044702 |