sphinx-contrib / sadisplay /

Filename Size Date modified Message
..
sphinxcontrib
tests
105 B
946 B
81 B
1.1 KB
868 B
Display SqlAlchemy models
=========================

Rendering PlantUML_ diagrams or GraphViz_ directed graphs generated from
SqlALchemy models.

Most part of code based on sphinxcontrib-plantuml_ source code.

Install
-------

::

    pip install sphinxcontrib-sadisplay


Usage
-----

Add sadisplay to extensions list::

    extenstion = ['sphinxcontrib.sadisp', ]

Add options to conf.py::

    plantuml = 'java -jar plantuml.jar'.split()
    graphviz = 'dot -Tpng'.split()
    sadisplay_default_render = 'plantuml' 


Render image::

    .. sadisplay::
        :module: myapp.model.user, myapp.model.post


Render link to image (html only)::

    .. sadisplay::
        :module: myapp.model.user, myapp.model.post
        :link:
        :alt: My Schema
        :render: graphviz


.. _PlantUML: http://plantuml.sourceforge.net/
.. _GraphViz: http://www.graphviz.org/
.. _sphinxcontrib-plantuml: http://bitbucket.org/birkenfeld/sphinx-contrib
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.