Skip to main content

Sphinx Extension for Schema generation

Project description

Latest Version 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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page