Skip to content

Simple sphinx wrapper around pyreverse (from pylint suit) to generate UML diagramms from modules.

License

Notifications You must be signed in to change notification settings

MeWu-IDM/sphinx-pyreverse

 
 

Repository files navigation

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.

About

Simple sphinx wrapper around pyreverse (from pylint suit) to generate UML diagramms from modules.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 76.9%
  • Shell 23.1%