sphinxcontrib-spelling / 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
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.