Sphinx-pyreverse
=================
.. image:: https://circleci.com/gh/alendit/sphinx-pyreverse.svg?style=svg
:target: https://circleci.com/gh/alendit/sphinx-pyreverse
.. image:: https://badge.fury.io/py/sphinx-pyreverse.svg
:target: https://badge.fury.io/py/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:
* `-v switch`_
* `-w switch`_
.. _-v switch: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-v
.. _-w switch: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-w
Raw data
{
"_id": null,
"home_page": "https://github.com/alendit/sphinx-pyreverse",
"name": "sphinx-pyreverse",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sphinx extension uml pyreverse",
"author": "Dimitri Vorona",
"author_email": "vorona@in.tum.de",
"download_url": "https://files.pythonhosted.org/packages/a1/4c/bdc20303b6d6df48927fed176176161d7bca8570b366f40870ceeff4814a/sphinx-pyreverse-0.0.18.tar.gz",
"platform": null,
"description": "Sphinx-pyreverse\n=================\n\n.. image:: https://circleci.com/gh/alendit/sphinx-pyreverse.svg?style=svg\n :target: https://circleci.com/gh/alendit/sphinx-pyreverse\n\n.. image:: https://badge.fury.io/py/sphinx-pyreverse.svg\n :target: https://badge.fury.io/py/sphinx-pyreverse\n\nA simple sphinx extension to generate a UML diagram from python modules.\n\nInstall\n--------\n\nInstall with:::\n\n pip install sphinx-pyreverse\n\nUsage\n------\n\nAdd \"sphinx_pyreverse\" to the extensions list in your conf.py (make sure it is\nin the PYTHONPATH).\n\nCall the directive with path to python module as content. The ``:classes:`` and\n``:packages:`` flags specify which UML diagrams to show.::\n\n .. uml:: {{modulename}}\n :classes:\n :packages:\n\nRequires pyreverse from pylint.\n\nOptions\n^^^^^^^\n\nTo configure usage, in your conf.py\n\n* ``sphinx_pyreverse_output`` (see --output), default is \"png\"\n* ``sphinx_pyreverse_filter_mode`` (see --filter_mode), default is None\n* ``sphinx_pyreverse_class`` (see --class), default is None\n* ``sphinx_pyreverse_show_ancestors`` (see --show_ancestors), default is None\n* ``sphinx_pyreverse_all_ancestors`` (see --all_ancestors), default is None\n* ``sphinx_pyreverse_show_associated`` (see --show_associated), default is None\n* ``sphinx_pyreverse_all_associated`` (see --all_associated), default is None\n* ``sphinx_pyreverse_show_builtin`` (see --show_builtin), default is None\n* ``sphinx_pyreverse_module_names`` (see --module_names), default is None\n* ``sphinx_pyreverse_only_classnames`` (see --only_classnames), default is None\n* ``sphinx_pyreverse_ignore`` (see --ignore), default is None\n* ``sphinx_pyreverse_image_max_width`` (int) Rendered output max width in pixels. default is 1000\n* ``sphinx_pyreverse_image_scale`` (float) Scale the rendered output. default is 1.0\n* ``sphinx_pyreverse_colorized`` (see --colorized), default is None\n\nChanging the directive\n^^^^^^^^^^^^^^^^^^^^^^\n\nTo override the directive, which defaults to 'uml' set the\n``SPHINX_PYREVERSE_DIRECTIVE`` environment variable to whatever you like.\n\nTroubleshooting\n^^^^^^^^^^^^^^^\n\n``sphinx-pyreverse`` uses sphinx-docs' logging api to write information to the log-files.\n\nTo use it run your ``sphinx-build`` command with ``-v -v -v -w $(pwd)/sphinx.log`` .\n\nFor more information see:\n\n * `-v switch`_ \n * `-w switch`_ \n\n\n.. _-v switch: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-v\n.. _-w switch: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-w\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A simple sphinx extension to generate UML diagrams with pyreverse",
"version": "0.0.18",
"project_urls": {
"Homepage": "https://github.com/alendit/sphinx-pyreverse"
},
"split_keywords": [
"sphinx",
"extension",
"uml",
"pyreverse"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40fb750a6c03e270a3f57c6349b751bb3ed18c894dfd6c8f26cd736672cd8232",
"md5": "7d36216cf968437d25b36a326c24f9e1",
"sha256": "2a8f998f32220aa9f9beea69bb6eba8618fd7548656eb4568ba075812314fbae"
},
"downloads": -1,
"filename": "sphinx_pyreverse-0.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d36216cf968437d25b36a326c24f9e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17611,
"upload_time": "2024-04-27T18:03:48",
"upload_time_iso_8601": "2024-04-27T18:03:48.374103Z",
"url": "https://files.pythonhosted.org/packages/40/fb/750a6c03e270a3f57c6349b751bb3ed18c894dfd6c8f26cd736672cd8232/sphinx_pyreverse-0.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a14cbdc20303b6d6df48927fed176176161d7bca8570b366f40870ceeff4814a",
"md5": "c791e4b4f17d86b33427e779fbad55af",
"sha256": "9cb2b2693fbffeb4a0ca7f911d1e4c07e201c8fd1e390f7a2b83b9ac5b8ddb2d"
},
"downloads": -1,
"filename": "sphinx-pyreverse-0.0.18.tar.gz",
"has_sig": false,
"md5_digest": "c791e4b4f17d86b33427e779fbad55af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20319,
"upload_time": "2024-04-27T18:03:50",
"upload_time_iso_8601": "2024-04-27T18:03:50.431543Z",
"url": "https://files.pythonhosted.org/packages/a1/4c/bdc20303b6d6df48927fed176176161d7bca8570b366f40870ceeff4814a/sphinx-pyreverse-0.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 18:03:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alendit",
"github_project": "sphinx-pyreverse",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "sphinx-pyreverse"
}
JSON
