Skip to content

SamWilsn/undocinclude

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Like sphinx' literalinclude, but skips docstrings

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages