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.1.tar.gz
(5.8 kB
view hashes)
Built Distribution
Close
Hashes for undocinclude-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb0a78bea9afca792dfdebb2dd561db52e6fe2c8b6579da10045238434e0ec31 |
|
MD5 | 1b63e14922b667c234932ae00104efeb |
|
BLAKE2b-256 | a918970e19ebb5c95794e4b158c1cbbc8f619c43e3eac2288d67e4c29e7487fe |