Sphinx-pyreverse
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:
2 maintainers
Metadata
2 maintainers
Release files for sphinx-pyreverse 0.0.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-pyreverse-0.0.18.tar.gz | 20.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_pyreverse-0.0.18-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 37.9 kB
Release files / sphinx-pyreverse-0.0.18.tar.gz
| Download URL | sphinx-pyreverse-0.0.18.tar.gz |
|---|---|
| Size | 20.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9cb2b2693fbffeb4a0ca7f911d1e4c07e201c8fd1e390f7a2b83b9ac5b8ddb2d
|
|
BLAKE2b-256 checksum How to use checksums |
a14cbdc20303b6d6df48927fed176176161d7bca8570b366f40870ceeff4814a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.11
|
Release files / sphinx_pyreverse-0.0.18-py3-none-any.whl
| Download URL | sphinx_pyreverse-0.0.18-py3-none-any.whl |
|---|---|
| Size | 17.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2a8f998f32220aa9f9beea69bb6eba8618fd7548656eb4568ba075812314fbae
|
|
BLAKE2b-256 checksum How to use checksums |
40fb750a6c03e270a3f57c6349b751bb3ed18c894dfd6c8f26cd736672cd8232
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.11
|
