Integrate .readthedocs.yaml (#193)

Done using zopefoundation/meta#205. --------- Co-authored-by: Michael Howitz <[email protected]>
zopefoundation · Sep 29, 2023 · 09cc2e7 · 09cc2e7
1 parent c2ceef5
commit 09cc2e7
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 17 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -102,7 +102,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
-          - "3.12.0-alpha.7"
+          - "3.12.0-rc.3"
         os: [ubuntu-20.04, macos-11]
         exclude:
           - os: macos-11
@@ -179,15 +179,15 @@ jobs:
           python setup.py build_ext -i
           python setup.py bdist_wheel
 
-      - name: Install BTrees and dependencies (3.12.0-alpha.7)
-        if: matrix.python-version == '3.12.0-alpha.7'
+      - name: Install BTrees and dependencies (3.12.0-rc.3)
+        if: matrix.python-version == '3.12.0-rc.3'
         run: |
           # Install to collect dependencies into the (pip) cache.
           # Use "--pre" here because dependencies with support for this future
           # Python release may only be available as pre-releases
           pip install --pre .[test]
       - name: Install BTrees and dependencies
-        if: matrix.python-version != '3.12.0-alpha.7'
+        if: matrix.python-version != '3.12.0-rc.3'
         run: |
           # Install to collect dependencies into the (pip) cache.
           pip install .[test]
@@ -231,7 +231,7 @@ jobs:
           && startsWith(github.ref, 'refs/tags')
           && startsWith(runner.os, 'Mac')
           && !startsWith(matrix.python-version, 'pypy')
-          && !startsWith(matrix.python-version, '3.12.0-alpha.7')
+          && !startsWith(matrix.python-version, '3.12.0-rc.3')
         env:
           TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
         run: |
@@ -250,7 +250,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
-          - "3.12.0-alpha.7"
+          - "3.12.0-rc.3"
         os: [ubuntu-20.04, macos-11]
         exclude:
           - os: macos-11
@@ -287,8 +287,8 @@ jobs:
         with:
           name: BTrees-${{ runner.os }}-${{ matrix.python-version }}.whl
           path: dist/
-      - name: Install BTrees 3.12.0-alpha.7
-        if: ${{ startsWith(matrix.python-version, '3.12.0-alpha.7') }}
+      - name: Install BTrees 3.12.0-rc.3
+        if: ${{ startsWith(matrix.python-version, '3.12.0-rc.3') }}
         run: |
           pip install -U wheel setuptools
           # coverage has a wheel on PyPI for a future python version which is
@@ -302,7 +302,7 @@ jobs:
           # Python release may only be available as pre-releases
           pip install --pre -U -e .[test]
       - name: Install BTrees
-        if: ${{ !startsWith(matrix.python-version, '3.12.0-alpha.7') }}
+        if: ${{ !startsWith(matrix.python-version, '3.12.0-rc.3') }}
         run: |
           pip install -U wheel setuptools
           pip install -U coverage

diff --git a/.meta.toml b/.meta.toml
@@ -2,7 +2,7 @@
 # https://github.com/zopefoundation/meta/tree/master/config/c-code
 [meta]
 template = "c-code"
-commit-id = "fe63cb4c"
+commit-id = "b21fbbf2"
 
 [python]
 with-appveyor = true
@@ -41,6 +41,7 @@ fail-under = 93
 
 [manifest]
 additional-rules = [
+    "include *.yaml",
     "include *.sh",
     "recursive-include docs *.bat",
     "recursive-include docs *.css",

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,25 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/c-code
+# 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/CHANGES.rst b/CHANGES.rst
@@ -7,7 +7,7 @@
 
 - Drop using ``setup_requires`` due to constant problems on GHA.
 
-- Add preliminary support for Python 3.12a7.
+- Add preliminary support for Python 3.12rc3.
 
 
 5.0 (2023-02-10)

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -14,6 +14,7 @@ recursive-include docs *.txt
 recursive-include docs Makefile
 
 recursive-include src *.py
+include *.yaml
 include *.sh
 recursive-include docs *.bat
 recursive-include docs *.css

diff --git a/doc-requirements.txt b/doc-requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -118,7 +118,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'default'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+Sphinx
+repoze.sphinx.autointerface
diff --git a/tox.ini b/tox.ini
@@ -28,6 +28,8 @@ setenv =
     PYTHONDEVMODE=1
     ZOPE_INTERFACE_STRICT_IRO=1
     ZOPE_INTERFACE_LOG_CHANGED_IRO=1
+    py312: VIRTUALENV_PIP=23.1.2
+    py312: PIP_REQUIRE_VIRTUALENV=0
 commands =
     zope-testrunner --test-path=src {posargs:-vc}
     sphinx-build -b doctest -d {envdir}/.cache/doctrees docs {envdir}/.cache/doctest