Add graph model diagrams #977 (#1350)

johnmhoran · web-flow · commit 5092a7970372 · 2023-12-13T01:21:13.000+05:30
* Add graph model diagrams #977 Reference: #977 Signed-off-by: John M. Horan <johnmhoran@gmail.com> * Add django-extensions to setup.cfg #977 Reference: #977 Signed-off-by: John M. Horan <johnmhoran@gmail.com> --------- Signed-off-by: John M. Horan <johnmhoran@gmail.com>
diff --git a/docs/source/_static/theme_overrides.css b/docs/source/_static/theme_overrides.css
@@ -29,3 +29,7 @@ div.rst-content {
             margin-left: 0px;
         }
 }
+
+.with-shadow {
+    box-shadow: 1px 1px 5px 3px #cccccc;
+}
diff --git a/docs/source/images/vcio-db-admin-2023-11-27-01.png b/docs/source/images/vcio-db-admin-2023-11-27-01.png
diff --git a/docs/source/images/vcio-db-application-2023-11-27-01.png b/docs/source/images/vcio-db-application-2023-11-27-01.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -36,6 +36,7 @@ In this documentation you will find information on:
     reference_importer_overview
     reference_improver_overview
     reference_framework_overview
+    reference_model_overview
     command-line-interface
     importers_link
 
diff --git a/docs/source/reference_model_overview.rst b/docs/source/reference_model_overview.rst
@@ -0,0 +1,25 @@
+.. _reference_model_overview:
+
+Model Overview
+=================
+
+This is a set of Graphviz-based graph diagrams of the application and admin models as of 2023-11-27:
+
+Application
+-----------
+
+.. figure:: images/vcio-db-application-2023-11-27-01.png
+    :alt: alternate text
+    :width: 100%
+    :class: with-shadow
+
+.. rst-class::  clear-both
+
+
+Admin
+-----
+
+.. figure:: images/vcio-db-admin-2023-11-27-01.png
+    :alt: alternate text
+    :width: 70%
+    :class: with-shadow
diff --git a/setup.cfg b/setup.cfg
@@ -58,6 +58,7 @@ install_requires =
     Django>=4.0.0
     psycopg2-binary>=2.8.6
     djangorestframework>=3.12.4
+    django-extensions>=3.2.3
     django-filter>=2.4.0
     django-widget-tweaks>=1.4.8
     django-crispy-forms>=1.10.0
diff --git a/vulnerablecode/settings.py b/vulnerablecode/settings.py
@@ -70,6 +70,7 @@
     "django.contrib.admin",
     "django.contrib.humanize",
     # Third-party apps
+    "django_extensions",
     "django_filters",
     "rest_framework",
     "rest_framework.authtoken",

Original file line number	Diff line number	Diff line change
`@@ -29,3 +29,7 @@ div.rst-content {`
`29`	`29`	`margin-left: 0px;`
`30`	`30`	`}`
`31`	`31`	`}`
	`32`	`+`
	`33`	`+.with-shadow {`
	`34`	`+ box-shadow: 1px 1px 5px 3px #cccccc;`
	`35`	`+}`