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.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9c92ebb28928f079134dfa5feeac1df4c625a5fad78e80f4a845566475b5127 |
|
MD5 | 0af3d8ff09e9258886f332c41b8f67c8 |
|
BLAKE2b-256 | 3ac28d933196fe677f94928a437327c2d9984730067a015e097a29e04fa08776 |
Hashes for sphinx_pyreverse-0.0.14-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 171095af14e7773da88e24d708e82645597d1e544e46ccc484b3451c597bf4a9 |
|
MD5 | b88c8b66e68ceb518a8893d26ddbaa4d |
|
BLAKE2b-256 | bd63a566da75a9979d66dbc5539dcf4b88903c246e422a31e5a1251db4d7a2c4 |