Metadata-Version: 2.1
Name: sphinx-pyreverse
Version: 0.0.13
Summary: A simple sphinx extension to generate UML diagrams with pyreverse
Home-page: https://github.com/alendit/sphinx-pyreverse
Author: Dimitri Vorona
Author-email: vorona@in.tum.de
License: GPLv3
Keywords: sphinx extension uml pyreverse
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Topic :: Utilities
Requires-Dist: sphinx
Requires-Dist: docutils

Sphinx-pyreverse
=================

A simple sphinx extension to generate a UML diagram from python modules.

Install
--------

Install with:::

    pip install -e git+https://github.com/alendit/sphinx-pyreverse.git#egg=sphinx-pyreverse

Usage
------

Add "sphinx_pyreverse" to the extensions list in your conf.py (make sure it is
in the PYTHONPATH).

Call the directive with path to python module as content. The ``:classes:`` and
``:packages:`` flags specify which UML diagrams to show.::

    .. uml:: {{modulename}}
        :classes:
        :packages:

Requires pyreverse from pylint.


