Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 781 Bytes

README.rst

File metadata and controls

32 lines (21 loc) · 781 Bytes

Sphinx-pyreverse

https://circleci.com/gh/alendit/sphinx-pyreverse.svg?style=svg

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

Install

Install with::

pip install 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.