From 42f387d105c305757c8c8c3737c39c960f452acb Mon Sep 17 00:00:00 2001 From: Daniel Havlik Date: Fri, 22 Sep 2023 11:03:26 +0200 Subject: [PATCH] Integrate .readthedocs.yaml (#119) Done using https://github.com/zopefoundation/meta/pull/205. --- .meta.toml | 3 ++- .readthedocs.yaml | 25 +++++++++++++++++++++++++ MANIFEST.in | 1 + doc-requirements.txt | 2 -- docs/requirements.txt | 2 ++ setup.cfg | 2 +- tox.ini | 2 ++ 7 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 doc-requirements.txt create mode 100644 docs/requirements.txt diff --git a/.meta.toml b/.meta.toml index e91bc3b8..d1e7c8f1 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 = "552fe384" +commit-id = "b21fbbf2" [python] with-windows = false @@ -23,6 +23,7 @@ fail-under = 95 [manifest] additional-rules = [ + "include *.yaml", "recursive-include src *.rst", "recursive-include src *.zcml", "recursive-include src *.pt", diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..034043e1 --- /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 cee36623..938572bc 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 src *.rst recursive-include src *.zcml recursive-include src *.pt diff --git a/doc-requirements.txt b/doc-requirements.txt deleted file mode 100644 index 38cef165..00000000 --- a/doc-requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -# This file is used by ReadTheDocs to generate the documentation. -.[docs] diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..e3579011 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx +repoze.sphinx.autointerface diff --git a/setup.cfg b/setup.cfg index 229cbe33..09d8284b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -17,7 +17,7 @@ ignore = force_single_line = True combine_as_imports = True sections = FUTURE,STDLIB,THIRDPARTY,ZOPE,FIRSTPARTY,LOCALFOLDER -known_third_party = six, docutils, pkg_resources, pytz +known_third_party = docutils, pkg_resources, pytz known_zope = known_first_party = default_section = ZOPE diff --git a/tox.ini b/tox.ini index cf424881..205b9c48 100644 --- a/tox.ini +++ b/tox.ini @@ -14,6 +14,8 @@ envlist = [testenv] usedevelop = true +package = wheel +wheel_build_env = .pkg deps = zope.testrunner commands =