sphinx_uml.pyreverse.cli module#

Based on the pylint.pyreverse.main module. Under Debian, see the /usr/lib/python3/dist-packages/pylint/__init__.py file.

sphinx_uml.pyreverse.cli.run_pyreverse2(args: list[str] = None)[source]#

pyreverse2 entry point, which is used to draw UML diagrams by inspecting some python module.

To display the help related to this program:

pyreverse2 --help

To run this program:

pyreverse2 \
    --output svg \
    --project example.a \
    --sphinx-html-dir docs/_html \
    --output-directory docs/ \
    -m y \
    example.a

Parameters:: args (list[str]) – The arguments passed to the script. Example: sys.argv[1].