Skip to main content

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 -e git+https://github.com/alendit/sphinx-pyreverse.git#egg=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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-pyreverse-0.0.13.tar.gz (4.5 kB view details)

Uploaded Source

Built Distributions

sphinx_pyreverse-0.0.13-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

sphinx_pyreverse-0.0.13-py2-none-any.whl (15.7 kB view details)

Uploaded Python 2

File details

Details for the file sphinx-pyreverse-0.0.13.tar.gz.

File metadata

  • Download URL: sphinx-pyreverse-0.0.13.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for sphinx-pyreverse-0.0.13.tar.gz
Algorithm Hash digest
SHA256 3b6d373c4981b5d3495355ddd4c4d13d59cb1795b520a88c3f987640ac8c3b4c
MD5 dc2fc1624690f0513f3f5a382cc03d99
BLAKE2b-256 9816153cfc67471076c3892a7db68642b55c65514ba9636a46cf066a5eeaa836

See more details on using hashes here.

File details

Details for the file sphinx_pyreverse-0.0.13-py3-none-any.whl.

File metadata

  • Download URL: sphinx_pyreverse-0.0.13-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for sphinx_pyreverse-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 b6152686795c2ed27f3bba2504d6d914a2483b3901cda9912037025d502992f8
MD5 ec5da8651c064209351f3a1b22390207
BLAKE2b-256 695f0643df8c7a7c47b55ee168890d22c208a2288a6acca3af95f69cc2814075

See more details on using hashes here.

File details

Details for the file sphinx_pyreverse-0.0.13-py2-none-any.whl.

File metadata

  • Download URL: sphinx_pyreverse-0.0.13-py2-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for sphinx_pyreverse-0.0.13-py2-none-any.whl
Algorithm Hash digest
SHA256 b0641bb82ed287cf0e263f9109cd8b30e3a513fa79011d9f2738ad1ed795405d
MD5 9faaaec08ae60b4d081047a9448275a6
BLAKE2b-256 8e7bc3d7e02d3e8741e39fe1a8da34356adef0afd551e9fdebfd4e48b7df4ff2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page