Fix generating documentation. (#24)

Use `Sphinx < 4` to prevent problems with `repoze.sphinx.autointerface`.

.github/workflows/tests.yml

@@ -4,14 +4,17 @@ name: tests
 
 on:
   push:
-    branches: [ master ]
   pull_request:
   schedule:
     - cron: '0 12 * * 0'  # run once a week on Sunday
+  # Allow to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
   build:
     strategy:
+      # We want do see all failures:
+      fail-fast: false
       matrix:
         config:
         # [Python version, tox env]

.gitignore

@@ -10,6 +10,7 @@
 .installed.cfg
 .mr.developer.cfg
 .tox/
+.vscode/
 __pycache__/
 bin/
 build/

.meta.toml

@@ -2,7 +2,7 @@
 # https://github.com/zopefoundation/meta/tree/master/config/zope-product
 [meta]
 template = "zope-product"
-commit-id = "4415752fead07401ce0e45c7d27ed81f6eeddf4f"
+commit-id = "f8468b0bc5c92479b3043372d89cf5852176015d"
 
 [python]
 with-appveyor = false
@@ -29,11 +29,16 @@ additional-rules = [
     "include buildout4.cfg",
     "recursive-include src *.dtml",
     "recursive-include src *.gif",
+    "recursive-include src *.pt",
     "recursive-include src *.xml",
+    "recursive-include src *.zcml",
     ]
 
 [check-manifest]
 additional-ignores = [
     "docs/_build/html/_sources/narrative/*",
     "docs/_build/html/_sources/api/*",
     ]
+
+[tox]
+use-flake8 = true

MANIFEST.in

@@ -5,18 +5,15 @@ include *.txt
 include buildout.cfg
 include tox.ini
 
-recursive-include docs *.bat
 recursive-include docs *.py
 recursive-include docs *.rst
 recursive-include docs *.txt
 recursive-include docs Makefile
 
-recursive-include src *.pt
 recursive-include src *.py
-recursive-include src *.rst
-recursive-include src *.txt
-recursive-include src *.zcml
 include buildout4.cfg
 recursive-include src *.dtml
 recursive-include src *.gif
+recursive-include src *.pt
 recursive-include src *.xml
+recursive-include src *.zcml

setup.cfg

@@ -23,7 +23,7 @@ force_single_line = True
 combine_as_imports = True
 sections = FUTURE,STDLIB,THIRDPARTY,ZOPE,FIRSTPARTY,LOCALFOLDER
 known_third_party = six, docutils, pkg_resources
-known_zope = 
+known_zope =
 known_first_party = Products.CMFCore
 default_section = ZOPE
 line_length = 79

tox.ini

@@ -19,6 +19,7 @@ skip_install = true
 deps =
     setuptools < 52
     zc.buildout
+    zope.testrunner
 commands_pre =
     py27,py35: {envbindir}/buildout -nc {toxinidir}/buildout4.cfg buildout:directory={envdir} buildout:develop={toxinidir} install test
     !py27-!py35: {envbindir}/buildout -nc {toxinidir}/buildout.cfg buildout:directory={envdir} buildout:develop={toxinidir} install test
@@ -27,10 +28,10 @@ commands =
 
 [testenv:lint]
 basepython = python3
-allowlist_externals =
-    mkdir
 commands_pre =
     mkdir -p {toxinidir}/parts/flake8
+allowlist_externals =
+    mkdir
 commands =
     isort --check-only --diff {toxinidir}/src {toxinidir}/setup.py
     - flake8 --format=html {toxinidir}/src {toxinidir}/setup.py
@@ -60,7 +61,8 @@ commands =
 [testenv:docs]
 basepython = python3
 skip_install = false
-deps =
+# Until repoze.sphinx.autointerface supports Sphinx 4.x we cannot use it:
+deps = Sphinx < 4
 extras =
     docs
 commands_pre =