Merge branch '6.0' into chapter-deprecation

Author: MrTango

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/build_deploy.yml

@@ -54,7 +54,7 @@ jobs:
         run: |
           echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         name: Setup pnpm cache
         with:
           path: ${{ env.STORE_PATH }}

.github/workflows/update_submodule.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Checkout
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: 6.0
           submodules: true

.readthedocs.yaml

@@ -18,7 +18,7 @@ build:
     # If there are no changes (git diff exits with 0) we force the command to return with 183.
     # This is a special exit code on Read the Docs that will cancel the build immediately.
     - |
-      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/6.0 -- docs/ .readthedocs.yaml requirements-initial.txt requirements.txt;
+      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/6.0 -- docs/ Makefile .readthedocs.yaml requirements-initial.txt requirements.txt;
       then
         exit 183;
       fi

.vale.ini

@@ -10,3 +10,5 @@ Packages = Microsoft
 BasedOnStyles = Vale, Microsoft
 Microsoft.Contractions = suggestion
 Microsoft.Units = suggestion
+; ignore MyST reference targets
+TokenIgnores = \([a-zA-Z0-9._-]*\)=

Makefile

@@ -30,162 +30,183 @@ clean:  ## Clean docs build directory
 	cd $(DOCS_DIR) && rm -rf $(BUILDDIR)/
 
 .PHONY: distclean
-distclean: clean ## Clean docs build directory, Python virtual environment, and symlinks
+distclean: clean ## Clean Python virtual environment and symlinks to submodules
 	rm -rf venv
 	rm docs/plone.api
 	rm docs/plone.restapi
 	rm docs/volto
+	@echo "Cleaned Python virtual environment and symlinks to submodules."
 	@echo
-	@echo "Cleaned docs build directory, Python virtual environment, and symlinks."
 
 venv/bin/python:  ## Setup up Python virtual environment and install requirements
 	python3 -m venv venv
 	venv/bin/pip install -r requirements-initial.txt
 	venv/bin/pip install -r requirements.txt
-	@echo
 	@echo "Installation of requirements completed."
+	@echo
 
 docs/plone.api:  ## Setup plone.api docs
 	git submodule init
 	git submodule update
-	venv/bin/pip install -e submodules/plone.api/"[test]"
 	ln -s ../submodules/plone.api/docs ./docs/plone.api
-	@echo
 	@echo "Documentation of plone.api initialized."
+	@echo
+
+venv/plone.api-install: docs/plone.api
+	touch venv/plone.api-install
+	venv/bin/pip install plone.api -c submodules/plone.api/constraints.txt
+	venv/bin/pip install --no-deps -e submodules/plone.api/"[test]"
+	@echo "plone.api installed."
+	@echo
 
 docs/plone.restapi:  ## Setup plone.restapi docs
 	git submodule init
 	git submodule update
 	ln -s ../submodules/plone.restapi ./docs/plone.restapi
-	@echo
 	@echo "Documentation of plone.restapi initialized."
+	@echo
 
 docs/volto:  ## Setup Volto docs
 	git submodule init
 	git submodule update
 	ln -s ../submodules/volto/docs/source ./docs/volto
-	@echo
 	@echo "Documentation of volto initialized."
+	@echo
 
-.PHONY: deps
-deps: venv/bin/python docs/volto docs/plone.restapi docs/plone.api  ## Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, and plone.api submodules, and finally create symlinks to the source files.
+ln-seven:  ## Toggle the symlink to Seven
+	rm docs/volto
+	ln -s ../submodules/volto/docs ./docs/volto
+	@echo "Symlink to Volto changed to Seven."
+	@echo
 
+ln-volto:  ## Toggle the symlink to Volto
+	rm docs/volto
+	ln -s ../submodules/volto/docs/source ./docs/volto
+	@echo "Symlink to Seven changed to Volto."
+	@echo
+
+.PHONY: deps
+deps: venv/bin/python docs/volto docs/plone.restapi venv/plone.api-install  ## Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, and plone.api submodules, create symlinks to the source files, and finally install plone.api.
 
 .PHONY: html
 html: deps  ## Build html
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+	@echo
 
 .PHONY: manual
 manual: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b html -t manual . $(BUILDDIR)/manual
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/manual."
+	@echo
 
 .PHONY: dirhtml
 dirhtml: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+	@echo
 
 .PHONY: singlehtml
 singlehtml: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+	@echo
 
 .PHONY: pickle
 pickle: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
 	@echo "Build finished; now you can process the pickle files."
+	@echo
 
 .PHONY: json
 json: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
 	@echo "Build finished; now you can process the JSON files."
+	@echo
 
 .PHONY: htmlhelp
 htmlhelp: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+	@echo
 
 .PHONY: epub
 epub: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+	@echo
 
 .PHONY: latex
 latex: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
 	      "(use \`make latexpdf' here to do that automatically)."
+	@echo
 
 .PHONY: latexpdf
 latexpdf: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 	@echo "Running LaTeX files through pdflatex..."
 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+	@echo
 
 .PHONY: text
 text: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+	@echo
 
 .PHONY: man
 man: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+	@echo
 
 .PHONY: texinfo
 texinfo: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo
 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 	@echo "Run \`make' in that directory to run these through makeinfo" \
 	      "(use \`make info' here to do that automatically)."
+	@echo
 
 .PHONY: info
 info: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 	@echo "Running Texinfo files through makeinfo..."
 	make -C $(BUILDDIR)/texinfo info
 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+	@echo
 
 .PHONY: changes
 changes: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
 	@echo "The overview file is in $(BUILDDIR)/changes."
+	@echo
 
 .PHONY: linkcheck
 linkcheck: deps  ## Run linkcheck
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 		"or in $(BUILDDIR)/linkcheck/ ."
+	@echo
 
 .PHONY: linkcheckbroken
 linkcheckbroken: deps  ## Run linkcheck and show only broken links
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | GREP_COLORS='0;31' grep -wi "broken\|redirect" --color=always | GREP_COLORS='0;31' grep -vi "https://github.com/plone/volto/issues/" --color=always && if test $$? = 0; then exit 1; fi || test $$? = 1
-	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 		"or in $(BUILDDIR)/linkcheck/ ."
+	@echo
 
 .PHONY: vale
 vale: deps  ## Run Vale style, grammar, and spell checks
 	venv/bin/vale sync
 	venv/bin/vale --no-wrap $(VALEOPTS) $(VALEFILES)
-	@echo
 	@echo "Vale is finished; look for any errors in the above output."
+	@echo
 
 .PHONY: html_meta
 html_meta: deps  ## Add meta data headers to all Markdown pages
@@ -196,6 +217,7 @@ doctest: deps
 	cd $(DOCS_DIR) && $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+	@echo
 
 .PHONY: test
 test: clean linkcheckbroken  ## Clean docs build, then run linkcheckbroken
@@ -219,7 +241,8 @@ rtd-pr-preview:  ## Build pull request preview on Read the Docs
 	pip install -r requirements.txt
 	git submodule init
 	git submodule update
-	pip install -e submodules/plone.api[test]
+	pip install plone.api -c submodules/plone.api/constraints.txt
+	pip install --no-deps -e submodules/plone.api[test]
 	ln -s ../submodules/volto/docs/source ./docs/volto
 	ln -s ../submodules/plone.restapi ./docs/plone.restapi
 	ln -s ../submodules/plone.api/docs ./docs/plone.api