Skip to content

Simple sphinx wrapper around pyreverse (from pylint suite) to generate UML diagrams from modules.

License

Notifications You must be signed in to change notification settings

eddy-geek/sphinx-pyreverse

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx-pyreverse

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

Install

Install with:

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

or:

git clone https://github.com/mattdavis90/sphinx-pyreverse.git
cd sphinx-pyreverse
sudo ./setup.py install

Usage

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

Call the directive with path to python module as content:

.. uml:: {{path to the module}}

Requires pyreverse from pylint.

About

Simple sphinx wrapper around pyreverse (from pylint suite) to generate UML diagrams from modules.

Resources

License

Stars

Watchers

Forks

Packages

No packages published