Skip to content

jeromemartin/sphinx-pyreverse

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 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/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 :namespaces: flags specify which UML diagrams to show.:

.. uml:: {{modulename}}
    :classes:
    :namespaces:
Ohter available flags from pyreverse::
  • show-ancestors
  • show-associated

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

 
 
 

Contributors

Languages

  • Python 100.0%