Skip to main content

A simple sphinx extension to generate UML diagrams with pyreverse

Project description

https://circleci.com/gh/alendit/sphinx-pyreverse.svg?style=svg https://badge.fury.io/py/sphinx-pyreverse.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.

Options

To configure usage, in your conf.py

  • sphinx_pyreverse_output (see –output), default is “png”
  • sphinx_pyreverse_filter_mode (see –filter_mode), default is None
  • sphinx_pyreverse_class (see –class), default is None
  • sphinx_pyreverse_show_ancestors (see –show_ancestors), default is None
  • sphinx_pyreverse_all_ancestors (see –all_ancestors), default is None
  • sphinx_pyreverse_show_associated (see –show_associated), default is None
  • sphinx_pyreverse_all_associated (see –all_associated), default is None
  • sphinx_pyreverse_show_builtin (see –show_builtin), default is None
  • sphinx_pyreverse_module_names (see –module_names), default is None
  • sphinx_pyreverse_only_classnames (see –only_classnames), default is None
  • sphinx_pyreverse_ignore (see –ignore), default is None

Changing the directive

To override the directive, which defaults to ‘uml’ set the SPHINX_PYREVERSE_DIRECTIVE environment variable to whatever you like.

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.17
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_pyreverse-0.0.17-py3-none-any.whl (17.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinx-pyreverse-0.0.17.tar.gz (19.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page