From 2f96be21c706848ce94ffe191830741626ae8039 Mon Sep 17 00:00:00 2001 From: Daniel Havlik Date: Fri, 22 Sep 2023 11:07:45 +0200 Subject: [PATCH] Integrate .readthedocs.yaml (#30) * Done using https://github.com/zopefoundation/meta/pull/205. --- .meta.toml | 3 ++- .readthedocs.yaml | 25 +++++++++++++++++++++++++ MANIFEST.in | 1 + docs/requirements.txt | 2 ++ rtd.txt | 1 - setup.cfg | 2 +- tox.ini | 1 + 7 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt delete mode 100644 rtd.txt diff --git a/.meta.toml b/.meta.toml index 523a28b..4635702 100644 --- a/.meta.toml +++ b/.meta.toml @@ -2,7 +2,7 @@ # https://github.com/zopefoundation/meta/tree/master/config/zope-product [meta] template = "zope-product" -commit-id = "4f0f7596" +commit-id = "b21fbbf2" [python] with-pypy = false @@ -25,6 +25,7 @@ additional-ignores = [ [manifest] additional-rules = [ + "include *.yaml", "recursive-include src *.dtml", "recursive-include src *.gif", "recursive-include src *.svg", diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..ecff5e7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,25 @@ +# Generated from: +# https://github.com/zopefoundation/meta/tree/master/config/zope-product +# 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 67a4b1f..8b9fea0 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 *.dtml recursive-include src *.gif recursive-include src *.svg diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..e357901 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx +repoze.sphinx.autointerface diff --git a/rtd.txt b/rtd.txt deleted file mode 100644 index e9704b8..0000000 --- a/rtd.txt +++ /dev/null @@ -1 +0,0 @@ -.[docs] diff --git a/setup.cfg b/setup.cfg index 10824b3..f30b412 100644 --- a/setup.cfg +++ b/setup.cfg @@ -19,7 +19,7 @@ ignore = force_single_line = True combine_as_imports = True sections = FUTURE,STDLIB,THIRDPARTY,ZOPE,FIRSTPARTY,LOCALFOLDER -known_third_party =six, MySQLdb, pkg_resources +known_third_party = six, MySQLdb, pkg_resources known_zope = known_first_party = default_section = ZOPE diff --git a/tox.ini b/tox.ini index 3b5cfe4..16f2d28 100644 --- a/tox.ini +++ b/tox.ini @@ -64,6 +64,7 @@ commands = basepython = python3 skip_install = true allowlist_externals = + {[testenv]allowlist_externals} mkdir deps = {[testenv]deps}