From 4ec65b9b8f9af1187a9a297b50418c7d4791cf68 Mon Sep 17 00:00:00 2001 From: nilo Date: Fri, 12 Apr 2024 09:10:25 +0200 Subject: [PATCH] Integrate .readthedocs.yaml. (#18) Co-authored-by: Daniel Havlik Co-authored-by: Michael Howitz --- .meta.toml | 3 ++- .readthedocs.yaml | 25 +++++++++++++++++++ MANIFEST.in | 1 + doc-requirements.txt => docs/requirements.txt | 4 +-- tox.ini | 2 ++ 5 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 .readthedocs.yaml rename doc-requirements.txt => docs/requirements.txt (51%) diff --git a/.meta.toml b/.meta.toml index 8dddfde..68dcad6 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 = "fd874ae4" +commit-id = "b21fbbf2" [python] with-windows = false @@ -20,5 +20,6 @@ fail-under = 100 [manifest] additional-rules = [ + "include *.yaml", "recursive-include src *.rst", ] 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 a6271b2..da2c930 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -12,4 +12,5 @@ recursive-include docs *.txt recursive-include docs Makefile recursive-include src *.py +include *.yaml recursive-include src *.rst diff --git a/doc-requirements.txt b/docs/requirements.txt similarity index 51% rename from doc-requirements.txt rename to docs/requirements.txt index 599908a..2d402fc 100644 --- a/doc-requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,3 @@ -pip>=9.0.0 -sphinx>=1.4 -setuptools>=23.0.0 +Sphinx repoze.sphinx.autointerface sphinx_rtd_theme diff --git a/tox.ini b/tox.ini index d24aeed..7cdac3d 100644 --- a/tox.ini +++ b/tox.ini @@ -15,6 +15,8 @@ envlist = [testenv] usedevelop = true +package = wheel +wheel_build_env = .pkg deps = commands = zope-testrunner --test-path=src {posargs:-vc}