Merge pull request #47 from maykinmedia/feature/43-setup-config-docs

📝 [#43] Update documentation for setup-configuration

docs/conf.py

@@ -8,11 +8,17 @@
 import os
 import sys
 
+import django
+from django.utils.translation import activate
+
 sys.path.insert(0, os.path.abspath("../src"))
 
 import referentielijsten  # noqa isort:skip
 
-# from objects.setup import setup_env  # noqa isort:skip
+from referentielijsten.setup import setup_env  # noqa isort:skip
+
+setup_env()
+django.setup()
 
 # TODO: This needs to be enabled when we want to use autodoc to grab
 # documentation from classes and functions. However, enabling django.setup()
@@ -42,6 +48,9 @@
     # "sphinx_tabs.tabs",
     # "recommonmark",
     # "sphinx_markdown_tables",
+    "sphinx.ext.autodoc",
+    "django_setup_configuration.documentation.setup_config_example",
+    "django_setup_configuration.documentation.setup_config_usage",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -54,6 +63,10 @@
 # Usually you set "language" from the command line for these cases.
 language = "en"
 
+# Also set the language to English for Django, to make sure that any translatable text
+# is also shown in English (for instance the help texts for setup configuration examples)
+activate("en")
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.

docs/installation/index.rst

@@ -15,4 +15,4 @@ this.
    :caption: Further reading
 
    config
-   setup_configuraiton
+   setup_configuration

docs/installation/setup_configuration.rst

@@ -0,0 +1,7 @@
+.. _installation_configuration_cli:
+
+=====================================
+Referentielijsten configuration (CLI)
+=====================================
+
+.. setup-config-usage::

requirements/base.txt

@@ -154,7 +154,7 @@ django-sendfile2==0.7.1
     # via django-privates
 django-sessionprofile==3.0.0
     # via open-api-framework
-django-setup-configuration==0.5.0
+django-setup-configuration==0.7.1
     # via
     #   mozilla-django-oidc-db
     #   open-api-framework
@@ -187,6 +187,8 @@ djangorestframework-gis==1.0
     # via open-api-framework
 djangorestframework-inclusions==1.2.0
     # via open-api-framework
+docutils==0.21.2
+    # via django-setup-configuration
 drf-nested-routers==0.94.1
     # via commonground-api-common
 drf-spectacular==0.27.2
@@ -239,7 +241,7 @@ maykin-2fa==1.0.1
     # via open-api-framework
 mozilla-django-oidc==4.0.1
     # via mozilla-django-oidc-db
-mozilla-django-oidc-db==0.21.1
+mozilla-django-oidc-db==0.22.0
     # via
     #   -r requirements/base.in
     #   open-api-framework
@@ -327,6 +329,10 @@ rpds-py==0.19.1
     # via
     #   jsonschema
     #   referencing
+ruamel-yaml==0.18.10
+    # via django-setup-configuration
+ruamel-yaml-clib==0.2.12
+    # via ruamel-yaml
 sentry-sdk==2.13.0
     # via open-api-framework
 six==1.16.0

requirements/ci.txt

@@ -292,7 +292,7 @@ django-sessionprofile==3.0.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   open-api-framework
-django-setup-configuration==0.5.0
+django-setup-configuration==0.7.1
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
@@ -346,8 +346,11 @@ djangorestframework-inclusions==1.2.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   open-api-framework
-docutils==0.20.1
+docutils==0.21.2
     # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   django-setup-configuration
     #   sphinx
     #   sphinx-rtd-theme
 drf-nested-routers==0.94.1
@@ -496,7 +499,7 @@ mozilla-django-oidc==4.0.1
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   mozilla-django-oidc-db
-mozilla-django-oidc-db==0.21.1
+mozilla-django-oidc-db==0.22.0
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
@@ -686,6 +689,16 @@ rpds-py==0.19.1
     #   -r requirements/base.txt
     #   jsonschema
     #   referencing
+ruamel-yaml==0.18.10
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   django-setup-configuration
+ruamel-yaml-clib==0.2.12
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   ruamel-yaml
 sentry-sdk==2.13.0
     # via
     #   -c requirements/base.txt
@@ -709,7 +722,7 @@ sphinx==7.4.7
     #   -r requirements/test-tools.in
     #   sphinx-rtd-theme
     #   sphinxcontrib-jquery
-sphinx-rtd-theme==2.0.0
+sphinx-rtd-theme==3.0.2
     # via -r requirements/test-tools.in
 sphinxcontrib-applehelp==2.0.0
     # via sphinx

requirements/dev.txt

@@ -319,7 +319,7 @@ django-sessionprofile==3.0.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   open-api-framework
-django-setup-configuration==0.5.0
+django-setup-configuration==0.7.1
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
@@ -375,10 +375,11 @@ djangorestframework-inclusions==1.2.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   open-api-framework
-docutils==0.20.1
+docutils==0.21.2
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+    #   django-setup-configuration
     #   sphinx
     #   sphinx-rtd-theme
 drf-nested-routers==0.94.1
@@ -554,7 +555,7 @@ mozilla-django-oidc==4.0.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   mozilla-django-oidc-db
-mozilla-django-oidc-db==0.21.1
+mozilla-django-oidc-db==0.22.0
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
@@ -780,6 +781,16 @@ rpds-py==0.19.1
     #   -r requirements/ci.txt
     #   jsonschema
     #   referencing
+ruamel-yaml==0.18.10
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   django-setup-configuration
+ruamel-yaml-clib==0.2.12
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   ruamel-yaml
 sentry-sdk==2.13.0
     # via
     #   -c requirements/ci.txt
@@ -814,7 +825,7 @@ sphinx==7.4.7
     #   -r requirements/ci.txt
     #   sphinx-rtd-theme
     #   sphinxcontrib-jquery
-sphinx-rtd-theme==2.0.0
+sphinx-rtd-theme==3.0.2
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt