Metadata-Version: 2.1
Name: undocinclude
Version: 0.1.1
Summary: Sphinx' literalinclude, but without docstrings
Home-page: https://github.com/SamWilsn/undocinclude
Author: Sam Wilson
Author-email: sam.wilson@mesh.xyz
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md

undocinclude
============

Sphinx plugin that provides a directive `undocinclude`, which is basically [`literalinclude`][0] 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`:

```python
extensions = [
    # ...
    'undocinclude.extension',
    # ...
]
```

## Example

```rst
.. undocinclude:: /path/to/script.py
```

[0]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude


