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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file undocinclude-0.2.1-py2.py3-none-any.whl.
File metadata
- Download URL: undocinclude-0.2.1-py2.py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 2, Python 3
- Uploaded using 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.3 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ddd275fda79b43f7f799da1df835f4d06dd035208446b2357a39bc8a5dff949
|
|
| MD5 |
6c0f811da3fb43e832d07423c336205e
|
|
| BLAKE2b-256 |
915822e38c2d5e4de4765d869cc82b4dd6845eec0201cf337c99ba727592ee82
|
