Skip to main content

A simple sphinx extension to generate UML diagrams with pyreverse

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-pyreverse, version 0.0.13
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_pyreverse-0.0.13-py2-none-any.whl (15.7 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size sphinx_pyreverse-0.0.13-py3-none-any.whl (15.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size sphinx-pyreverse-0.0.13.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page