https://github.com/sphinx-contrib/sadisplay

A Sphinx extension for displaying SqlAlchemy model
https://github.com/sphinx-contrib/sadisplay

Last synced: about 2 months ago
JSON representation

A Sphinx extension for displaying SqlAlchemy model

• Host: GitHub
• URL: https://github.com/sphinx-contrib/sadisplay
• Owner: sphinx-contrib
• Created: 2017-09-28T15:01:33.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-05-12T18:27:57.000Z (about 4 years ago)
• Last Synced: 2025-04-22T20:50:41.236Z (2 months ago)
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 6
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
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