Merge pull request #652 from maykinmedia/feature/datamodel-image

✨ [maykinmedia/open-api-framework#159] add model img docs creation

Author: TimdeBeer1

.github/workflows/ci.yml

@@ -141,7 +141,7 @@ jobs:
       - store-reusable-workflow-vars
     with:
       main-branch: 'master'
-      apt-packages: 'libgdal-dev gdal-bin'
+      apt-packages: 'libgdal-dev gdal-bin graphviz graphviz-dev'
       run-docs: true
       django-settings-module: objects.conf.ci
       python-version: '3.12'

.gitignore

@@ -15,6 +15,7 @@ __pycache__
 
 # Generated files
 docs/_build
+/docs/_static/uml/*.png
 src/objects/static/bundles/
 /volumes/
 

.readthedocs.yaml

@@ -8,17 +8,15 @@ sphinx:
   configuration: docs/conf.py
 
 build:
-  os: 'ubuntu-22.04'
+  os: "ubuntu-22.04"
   apt_packages:
     - libxml2-dev
     - libxmlsec1-dev
     - libxmlsec1-openssl
     - wget
     - libgdal-dev
     - gdal-bin
+    - graphviz
+    - graphviz-dev
   tools:
-    python: '3.12'
-
-python:
-  install:
-    - requirements: requirements/dev.txt
+    python: "3.12"

docs/_static/uml/.gitkeep

@@ -16,6 +16,7 @@
 
 sys.path.insert(0, os.path.abspath("../src"))
 
+
 import objects  # noqa isort:skip
 from objects.setup import setup_env  # noqa isort:skip
 
@@ -54,9 +55,11 @@
     "sphinx_tabs.tabs",
     "recommonmark",
     "sphinx.ext.autodoc",
+    "sphinx.ext.graphviz",
     "django_setup_configuration.documentation.setup_config_example",
     "django_setup_configuration.documentation.setup_config_usage",
-    #    "sphinx_markdown_tables",
+    "vng_api_common.diagrams.uml_images",
+    "sphinx_markdown_tables",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -80,6 +83,9 @@
 
 source_suffix = [".rst", ".md"]
 
+# Datamodel image settings
+graphviz_output_format = "png"
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

docs/conf.py

@@ -28,6 +28,7 @@ configuration or development needed.
    background
    definitions
    information-model
+   uml-diagram
    metadata
    visualization
    features

docs/introduction/_assets/img/objecttypes.png

@@ -0,0 +1,25 @@
+UML Diagrams
+============
+
+This section contains UML diagrams for resources per components.
+
+.. note::
+
+    These are the underlying data models and this shows the relationships between the resources,
+    but not all attributes are the exact same as in the API.
+
+Objects API
+-----------
+.. uml_images::
+    :apps: core
+    :excluded_models: Service
+
+
+Objecttypes API
+---------------
+
+Core
+
+.. image:: _assets/img/objecttypes.png
+    :width: 100%
+    :alt: Objecttypes UML diagram.

docs/introduction/index.rst

@@ -60,7 +60,7 @@ click-plugins==1.1.1
     # via celery
 click-repl==0.3.0
     # via celery
-commonground-api-common==2.7.0
+commonground-api-common==2.9.0
     # via
     #   -r requirements/base.in
     #   open-api-framework

docs/introduction/uml-diagram.rst

@@ -111,7 +111,7 @@ click-repl==0.3.0
     #   celery
 codecov==2.1.13
     # via -r requirements/test-tools.in
-commonground-api-common==2.7.0
+commonground-api-common==2.9.0
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
@@ -434,6 +434,8 @@ kombu==5.5.4
     #   celery
 lxml==4.9.4
     # via pyquery
+markdown==3.8.2
+    # via sphinx-markdown-tables
 markupsafe==2.1.3
     # via jinja2
 maykin-2fa==1.0.1
@@ -672,6 +674,8 @@ sphinx==8.1.3
     #   sphinx-rtd-theme
     #   sphinx-tabs
     #   sphinxcontrib-jquery
+sphinx-markdown-tables==0.0.17
+    # via -r requirements/docs.in
 sphinx-rtd-theme==3.0.2
     # via -r requirements/docs.in
 sphinx-tabs==3.4.7