Merge pull request plone#1446 from plone/contribute-touch-up

Contributing: Add Python as a pre-requisite

Author: stevepiercy

Makefile

@@ -62,7 +62,7 @@ docs/volto:
 	@echo "Documentation of volto initialized."
 
 .PHONY: deps
-deps: 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.
+deps: 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.
 
 
 .PHONY: html

docs/_static/copy.svg

@@ -140,7 +140,7 @@
 
 html_static_path = [
     "volto/_static",
-    "_static",
+    "_static",  # Last path wins. See https://github.com/plone/documentation/pull/1442
 ]
 
 # -- Options for myST markdown conversion to html -----------------------------
@@ -214,7 +214,7 @@
 
 # -- sphinx-notfound-page configuration ----------------------------------
 
-notfound_urls_prefix = None
+notfound_urls_prefix = ""
 notfound_template = "404.html"
 
 

docs/conf.py

@@ -120,7 +120,7 @@ Note that the HTML attribute `class` must be set to `inline` to render the image
 
 The above syntax renders as shown below.
 
-> You can copy <img alt="Copy icon" src="../../_images/copy.svg" class="inline"> blocks.
+> You can copy <img alt="Copy icon" src="/_static/copy.svg" class="inline"> blocks.
 
 Images and figures should always include `alt` text.
 

docs/contributing/myst-reference.md

@@ -21,6 +21,15 @@ This document covers how to build the Plone Documentation and check it for quali
 Installation of Plone 6 Documentation includes pre-requisites and the repository itself.
 
 
+(setup-build-installation-python-label)=
+
+### Python
+
+Python 3.8 or later is required.
+A more recent Python is preferred.
+Use your system's package manager or [pyenv](https://github.com/pyenv/pyenv) to install an appropriate version of Python.
+
+
 (setup-build-installation-vale-label)=
 
 ### Vale