Merge pull request #414 from peopledoc/django-model-graph-generation

Added a tox job target to create a Django Model Graph using `dot`.

Author: brunobord

CHANGELOG.rst

@@ -5,7 +5,7 @@ ChangeLog
 master (unreleased)
 ==================
 
-Nothing to see here.
+- Added a tox job target to create a Django model graph using `dot`. Run `tox -e django_graph` to see the result. Since the database schema doesn't change that often, this tox target won't be associated with automated tests or doc generation - it's probably going to be a one-shot.
 
 Release 7.0.0 (2021-03-11)
 ==========================

README.rst

@@ -46,6 +46,19 @@ You can also browse the documentation locally, using the following, for example:
 
     $ make docs serve-docs
 
+About the model graph
+---------------------
+
+On the "intro" page of the documentation, you can see a graph of the different Django models defined in the application.
+
+To generate this graph, you'll need to have `graphviz installed <https://graphviz.org/download/>`_ on your system.
+
+When you're ready, you may initiate this generation using:
+
+.. code:: sh
+
+    $ tox -e django_graph
+
 Quick-Start
 ===========
 

docs/source/_static/django_graph.png

@@ -5,3 +5,9 @@ Introduction
 :mod:`django-formidable` allows your users to create/edit custom Django forms.
 :mod:`django-formidable` provides a RESTful API, which can be used in conjunction with a front-end application.
 A number of endpoints are provided in order to enable building forms via the API.
+
+
+Django model schema
+===================
+
+.. image:: _static/django_graph.png

docs/source/intro.rst

@@ -90,3 +90,18 @@ whitelist_externals = make
 changedir = docs
 commands =
     make collectstatic
+
+
+[testenv:django_graph]
+basepython = python3
+deps =
+    ; doc building is using the latest LTS version to date (june 2020)
+    Django>=2.2,<2.3
+    -rdemo/requirements-demo.pip
+    django-extensions
+    pyparsing
+    pydot
+changedir = demo
+whitelist_externals = make
+commands =
+    python manage.py graph_models formidable -o ../docs/source/_static/django_graph.png