From 882b27337478a39460b6172305b186d3836fa3ab Mon Sep 17 00:00:00 2001 From: Daniel Havlik Date: Fri, 22 Sep 2023 11:18:14 +0200 Subject: [PATCH] Integrate .readthedocs.yaml (#132) Done using https://github.com/zopefoundation/meta/pull/205. --- .meta.toml | 3 ++- .readthedocs.yaml | 25 +++++++++++++++++++++++++ MANIFEST.in | 1 + docs/requirements.txt | 2 ++ rtd.txt | 2 -- 5 files changed, 30 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 2f3fd756..f201303f 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 = "d0bc564f" +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 *.js", diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..ecff5e78 --- /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 87b18ecd..992c1651 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 *.js diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..e2831f46 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx +repoze.sphinx.autointerface \ No newline at end of file diff --git a/rtd.txt b/rtd.txt deleted file mode 100644 index 49c17739..00000000 --- a/rtd.txt +++ /dev/null @@ -1,2 +0,0 @@ -pkginfo -repoze.sphinx.autointerface