Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add graph model diagrams #977 #1350

Merged
merged 2 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/source/_static/theme_overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,7 @@ div.rst-content {
margin-left: 0px;
}
}

.with-shadow {
box-shadow: 1px 1px 5px 3px #cccccc;
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
25 changes: 25 additions & 0 deletions docs/source/reference_model_overview.rst
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions vulnerablecode/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
"django.contrib.admin",
"django.contrib.humanize",
# Third-party apps
"django_extensions",
"django_filters",
"rest_framework",
"rest_framework.authtoken",
Expand Down
Loading