https://github.com/electrocucaracha/schemadisplay_sphinx

Sphinx Extension to generate Entity Relationship Diagrams of sqlalchemy
https://github.com/electrocucaracha/schemadisplay_sphinx

Last synced: 8 days ago
JSON representation

Sphinx Extension to generate Entity Relationship Diagrams of sqlalchemy

• Host: GitHub
• URL: https://github.com/electrocucaracha/schemadisplay_sphinx
• Owner: electrocucaracha
• License: apache-2.0
• Created: 2016-01-21T22:00:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-05-10T21:35:23.000Z (over 8 years ago)
• Last Synced: 2024-10-10T13:36:09.583Z (about 1 month ago)
• Language: Python
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
==============================

Schemadisplay Sphinx Extension

==============================

.. image:: https://img.shields.io/pypi/v/schemadisplay-sphinx.svg

    :target: https://pypi.python.org/pypi/schemadisplay-sphinx/

    :alt: Latest Version

.. image:: https://img.shields.io/pypi/dm/schemadisplay-sphinx.svg

    :target: https://pypi.python.org/pypi/schemadisplay-sphinx/

    :alt: Downloads

This extension creates the Entitiy Relationship Diagram(ERD) of the

project in an image file.  The idea is that Database information

documentation keeps syncronized with the source code.

Configuration

-------------

    1. Add `schemadisplay_sphinx` module in sphinx entensions array.

    2. Define the `model_class_name` class.

    3. Specify the image path for the output in `model_schema_filename`.

    4. List folders to be ignored for the schema creation using `model_skip_folders`.

* Free software: Apache License, Version 2.0