Skip to main content

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

undocinclude-0.2.1-py2.py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page