Test of Preview Build

.github/workflows/rtd-pr-preview.yml

@@ -0,0 +1,22 @@
+# .github/workflows/rtd-pr-preview.yml
+name: readthedocs/actions
+on:
+  pull_request_target:
+    types:
+      - opened
+    # Execute this action only on PRs that touch
+    # documentation files.
+    # paths:
+    #   - "docs/**"
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "plone-sphinx-theme"
+          single-version: "true"

.readthedocs.yaml

@@ -0,0 +1,24 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+#    nodejs: "19"
+  commands:
+    - make rtd-pr-preview
+
+# Build documentation in the "docs/" directory with Sphinx
+#sphinx:
+#  configuration: docs/conf.py
+
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+#python:
+#  install:
+#    - requirements: docs/requirements.txt

Makefile

@@ -212,11 +212,9 @@ sbt-styles-update:  ## Copy Sphinx Book Theme styles to Plone Sphinx Theme
 kitchen-sink-update:  ## Copy Kitchen Sink documentation files to Plone Sphinx Theme
 	bin/python scripts/kitchen_sink_update.py
 
-.PHONY: netlify
-netlify:
-	pip install -r requirements-netlify.txt
-	pip install .
-	cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html && cp ./netlify_robots.txt $(BUILDDIR)/html/robots.txt
+.PHONY: rtd-pr-preview
+rtd-pr-preview: bin/python  ## Build pull request preview on Read the Docs
+	cd $(DOCS_DIR) && $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${READTHEDOCS_OUTPUT}/html/
 
 .PHONY: all
 all: clean vale linkcheck html  ## Clean docs build, then run vale and linkcheck, and build html

README.md

@@ -13,6 +13,10 @@ It is based on [`sphinx-book-theme`](https://sphinx-book-theme.readthedocs.io/en
 
 ## Documentation and demonstration
 
+Documentation is hosted on GitHub at a temporary URL:
+
+https://plone.github.io/plone-sphinx-theme/
+
 TODO:
 
 To build documentation and a demonstration of this project, you can use `make` commands.

package.json

@@ -10,8 +10,8 @@
     "extract-loader": "^4.0.3",
     "file-loader": "^5.0.2",
     "html-webpack-plugin": "^4.3.0",
-    "sass": "^1.75.0",
     "optimize-css-assets-webpack-plugin": "^5.0.3",
+    "sass": "^1.75.0",
     "sass-loader": "^10.1.1",
     "style-loader": "^1.1.3",
     "webpack": "^4.41.6",

pyproject.toml

@@ -33,6 +33,7 @@ classifiers = [
   "Operating System :: OS Independent",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",