diff --git a/docs/source/_static/theme_overrides.css b/docs/source/_static/theme_overrides.css index ce4aad98f..4ff114483 100644 --- 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 new file mode 100644 index 000000000..4afdc8cea Binary files /dev/null and b/docs/source/images/vcio-db-admin-2023-11-27-01.png differ 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 new file mode 100644 index 000000000..975dbe116 Binary files /dev/null and b/docs/source/images/vcio-db-application-2023-11-27-01.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index 69fcffe8c..be51eca80 100644 --- 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 new file mode 100644 index 000000000..715b9958c --- /dev/null +++ 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 index f1019f1dc..111a61ff3 100644 --- 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 index 48c849225..52d712a9b 100644 --- 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",