undocinclude

Like sphinx' literalinclude, but skips docstrings

OTHER License

Downloads
57
Stars
3
Committers
1

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