Skip to content

Commit

Permalink
Fix generating documentation.
Browse files Browse the repository at this point in the history
Use `Sphinx < 4` to prevent problems with `repoze.sphinx.autointerface`.
  • Loading branch information
Michael Howitz committed May 11, 2021
1 parent 2463560 commit f689c95
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 6 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/tests.yml
Expand Up @@ -7,10 +7,14 @@ on:
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 to see all failures:
fail-fast: false
matrix:
config:
# [Python version, tox env]
Expand Down
8 changes: 7 additions & 1 deletion .meta.toml
Expand Up @@ -2,7 +2,7 @@
# https://github.com/zopefoundation/meta/tree/master/config/pure-python
[meta]
template = "pure-python"
commit-id = "5ff06aa9d4d474924437add182099207b5b7f5f7"
commit-id = "d4e8550e4a37df10866d376fceac4e91689df8c5"

[python]
with-appveyor = false
Expand All @@ -16,3 +16,9 @@ use-flake8 = true

[coverage]
fail-under = 99.5

[manifest]
additional-rules = [
"recursive-include docs *.bat",
"recursive-include src *.zcml",
]
5 changes: 1 addition & 4 deletions MANIFEST.in
Expand Up @@ -5,14 +5,11 @@ 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 docs *.bat
recursive-include src *.zcml
7 changes: 6 additions & 1 deletion tox.ini
Expand Up @@ -19,6 +19,8 @@ envlist =
usedevelop = true
deps =
zope.testrunner
# Until repoze.sphinx.autointerface supports Sphinx 4.x we cannot use it:
Sphinx < 4
commands =
zope-testrunner --test-path=src {posargs:-vc}
sphinx-build -b doctest -d {envdir}/.cache/doctrees docs {envdir}/.cache/doctest
Expand All @@ -41,7 +43,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
commands_pre =
commands =
sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
Expand All @@ -54,6 +57,8 @@ allowlist_externals =
deps =
coverage
coverage-python-version
# Until repoze.sphinx.autointerface supports Sphinx 4.x we cannot use it:
Sphinx < 4
zope.testrunner
commands =
mkdir -p {toxinidir}/parts/htmlcov
Expand Down

0 comments on commit f689c95

Please sign in to comment.