docs: List DJANGOCMS_VERSIONING_LOCK_VERSIONS in settings (#350)

* docs: List DJANGOCMS_VERSIONING_LOCK_VERSIONS  in settings

* Add docs.yml action

* Create docs/requirements.txt

* Update docs.yml

* Update Makefile

* Update requirements.txt

* Fix Makefile for spelling

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: Docs
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - name: Cache dependencies
+        uses: actions/cache@v3.3.1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - run: python -m pip install -r docs/requirements.txt
+      - name: Build docs
+        run: |
+          cd docs
+          make html
+
+  spelling:
+    runs-on: ubuntu-latest
+    name: spelling
+    needs: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - name: Cache dependencies
+        uses: actions/cache@v3.3.1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - run: python -m pip install -r docs/requirements.txt
+      - name: Check spelling
+        run: |
+          cd docs
+          make spelling
+

docs/Makefile

@@ -13,6 +13,9 @@ help:
 
 .PHONY: help Makefile
 
+spelling:
+	$(SPHINXBUILD) -b spelling "$(SOURCEDIR)" $(BUILDDIR)/spelling $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinxcontrib-spelling

docs/settings.rst

@@ -21,3 +21,12 @@ Settings for djangocms Versioning
 
     The latest version (which is not a source of a newer version) can always be
     deleted (if the user has the appropriate rights).
+
+
+.. py:attribute: DJANGOCMS_VERSIONING_LOCK_VERSIONS
+
+    Defaults to ``False``
+
+    This setting controls if draft versions are locked. If they are, only the user 
+    who created the draft can change the draft. See :ref:`locking versions` for more
+    details.