Merge pull request #1605 from maykinmedia/restore-setup-configuration…

…-docs Restore setup configuration docs
maykinmedia · Feb 6, 2025 · ba5599e · ba5599e
2 parents 13a3663 + 93b881a
commit ba5599e
Show file tree

Hide file tree

Showing 22 changed files with 54 additions and 2,331 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -208,28 +208,6 @@ jobs:
           pytest check_sphinx.py -v --tb=auto
         working-directory: docs
 
-  setup-config-docs:
-    name: Check that documentation for configuration steps is up-to-date
-    runs-on: ubuntu-latest
-
-    # Disabled while we complete the upgrade to the latest setup-configuration
-    if: false
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: 'true'
-      - name: Set up backend environment
-        uses: maykinmedia/setup-django-backend@v1
-        with:
-          apt-packages: 'libxml2-dev libxmlsec1-dev libxmlsec1-openssl gettext libgdal-dev gdal-bin graphviz'
-          python-version: '3.11'
-          setup-node: 'no'
-
-      - name: Build docs for django-setup-configuration steps
-        run: |
-          python src/manage.py generate_config_docs --dry-run
-
   #
   # Docker
   #

diff --git a/docs/conf.py b/docs/conf.py
@@ -43,6 +43,8 @@
     "sphinx_tabs.tabs",
     "recommonmark",
     # "sphinx_markdown_tables",
+    "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.

diff --git a/docs/configuration/admin_oidc.rst b/docs/configuration/admin_oidc.rst
diff --git a/docs/configuration/cms_cases.rst b/docs/configuration/cms_cases.rst
diff --git a/docs/configuration/cms_collaborate.rst b/docs/configuration/cms_collaborate.rst
diff --git a/docs/configuration/cms_inbox.rst b/docs/configuration/cms_inbox.rst