Metadata-Version: 1.1
Name: sphinxcontrib-sadisplay
Version: 0.3.2.dev20171010
Summary: Sphinx "sadisplay" extension
Home-page: http://bitbucket.org/birkenfeld/sphinx-contrib
Author: Evgeniy Tatarkin
Author-email: tatarkin.evg@gmail.com
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-sadisplay
Description-Content-Type: UNKNOWN
Description: 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
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
