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
sphinx_pyreverse_image_max_width (int) Rendered output max width in pixels. default is 1000
sphinx_pyreverse_image_scale (float) Scale the rendered output. default is 1.0
sphinx_pyreverse_colorized (see –colorized), 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.
Troubleshooting
sphinx-pyreverse uses sphinx-docs’ logging api to write information to the log-files.
To use it run your sphinx-build command with -v -v -v -w $(pwd)/sphinx.log .
For more information see:
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 Distribution
File details
Details for the file sphinx-pyreverse-0.0.18.tar.gz
.
File metadata
- Download URL: sphinx-pyreverse-0.0.18.tar.gz
- Upload date:
- Size: 20.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cb2b2693fbffeb4a0ca7f911d1e4c07e201c8fd1e390f7a2b83b9ac5b8ddb2d |
|
MD5 | c791e4b4f17d86b33427e779fbad55af |
|
BLAKE2b-256 | a14cbdc20303b6d6df48927fed176176161d7bca8570b366f40870ceeff4814a |
File details
Details for the file sphinx_pyreverse-0.0.18-py3-none-any.whl
.
File metadata
- Download URL: sphinx_pyreverse-0.0.18-py3-none-any.whl
- Upload date:
- Size: 17.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a8f998f32220aa9f9beea69bb6eba8618fd7548656eb4568ba075812314fbae |
|
MD5 | 7d36216cf968437d25b36a326c24f9e1 |
|
BLAKE2b-256 | 40fb750a6c03e270a3f57c6349b751bb3ed18c894dfd6c8f26cd736672cd8232 |