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 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for sphinx_pyreverse-0.0.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3ec6763038af5c4f91491144afc758981de2f634903516d06a943dfd4753faf |
|
MD5 | f74e9f75786b113494ba5955f551f9c8 |
|
BLAKE2b-256 | e5a027b5e719b6c4aabbc8b064f26c9a489779ba7a574371ea312ed52c3996fd |
Hashes for sphinx_pyreverse-0.0.16-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 904758d1a9f739e943daa2043fac96a01ef3add001a8fe1f1faab637cbe7fe3b |
|
MD5 | d12d36fde3023b3df3fc34d968a5790c |
|
BLAKE2b-256 | 0ecbe0d571d3bd3aa9035054e4d2356e06d04fbf7d29e45606fc8cfb99ba0dfd |