From 4c3df5f41a52c1b046b0c3b04ceeed44e3982ffe Mon Sep 17 00:00:00 2001 From: Daniel Havlik Date: Fri, 22 Sep 2023 09:33:49 +0200 Subject: [PATCH] Integrate .readthedocs.yaml, done using https://github.com/zopefoundation/meta/pull/205. --- .github/workflows/tests.yml | 2 +- .meta.toml | 3 ++- .readthedocs.yaml | 25 +++++++++++++++++++++++++ MANIFEST.in | 1 + docs/requirements.txt | 5 +++++ tox.ini | 4 ++++ 6 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 8cbbf28..6d48988 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -27,7 +27,7 @@ jobs: - ["3.9", "py39"] - ["3.10", "py310"] - ["3.11", "py311"] - - ["3.12.0-beta.2", "py312"] + - ["3.12.0-rc.3", "py312"] - ["3.9", "docs"] - ["3.9", "coverage"] - ["3.9", "py39-datetime"] diff --git a/.meta.toml b/.meta.toml index 293bdd7..7bdc04e 100644 --- a/.meta.toml +++ b/.meta.toml @@ -2,7 +2,7 @@ # https://github.com/zopefoundation/meta/tree/master/config/pure-python [meta] template = "pure-python" -commit-id = "1814282a" +commit-id = "b21fbbf2" [python] with-pypy = false @@ -66,6 +66,7 @@ additional-sources = "tests" [manifest] additional-rules = [ + "include *.yaml", "recursive-include docs *.ast", "recursive-include docs *.bat", "recursive-include docs *.jpg", diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..034043e --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,25 @@ +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/pure-python +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: . diff --git a/MANIFEST.in b/MANIFEST.in index a1bb705..3c482de 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -12,6 +12,7 @@ recursive-include docs *.txt recursive-include docs Makefile recursive-include src *.py +include *.yaml recursive-include docs *.ast recursive-include docs *.bat recursive-include docs *.jpg diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..128a4ee --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +Sphinx>4.3 +sphinx-rtd-theme>=1 +ZConfig +Zope +tempstorage diff --git a/tox.ini b/tox.ini index b17d709..9c9fcce 100644 --- a/tox.ini +++ b/tox.ini @@ -17,6 +17,8 @@ envlist = [testenv] usedevelop = true +package = wheel +wheel_build_env = .pkg pip_pre = py312: true deps = datetime: DateTime @@ -25,6 +27,8 @@ deps = Sphinx setenv = COVERAGE_FILE=.coverage.{envname} + py312: VIRTUALENV_PIP=23.1.2 + py312: PIP_REQUIRE_VIRTUALENV=0 commands = python -V pytest --cov=src --cov=tests --cov-report= {posargs}