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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schemadisplay_sphinx-0.0.1-py2.7.egg (4.6 kB view details)

Uploaded Egg

File details

Details for the file schemadisplay_sphinx-0.0.1-py2.7.egg.

File metadata

File hashes

Hashes for schemadisplay_sphinx-0.0.1-py2.7.egg
Algorithm Hash digest
SHA256 5a3c56966bd9643eb0de630e8f6371c3f45a2a6897aeacc5a85008ca40116495
MD5 4a4a88513858faf865c448362c2d265b
BLAKE2b-256 6c558a54dd8029b51d0c6ae75527668e33b46d82b2937f519b90fed0e9a8efd7

See more details on using hashes here.

Supported by

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