Source

sphinx-contrib / sadisplay /

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

Used sphinxcontrib-plantuml_ extension for rendering PlantUML_ diagrams
generated by SqlALchemy models.

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

Install
-------

::

    pip install sphinxcontrib-sadisplay


Usage
-----

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


.. _PlantUML: http://plantuml.sourceforge.net/
.. _sphinxcontrib-plantuml: http://bitbucket.org/birkenfeld/sphinx-contrib