Skip to content

Commit

Permalink
Integrate .readthedocs.yaml.
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Havlik committed Sep 22, 2023
1 parent 2eb00ac commit 60dfedb
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 11 deletions.
18 changes: 9 additions & 9 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ jobs:
- "3.9"
- "3.10"
- "3.11"
- "3.12.0-beta.4"
- "3.12.0-rc.3"
os: [ubuntu-20.04, macos-11]
exclude:
- os: macos-11
Expand Down Expand Up @@ -178,15 +178,15 @@ jobs:
python setup.py build_ext -i
python setup.py bdist_wheel
- name: Install zope.index and dependencies (3.12.0-beta.4)
if: matrix.python-version == '3.12.0-beta.4'
- name: Install zope.index 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 zope.index and dependencies
if: matrix.python-version != '3.12.0-beta.4'
if: matrix.python-version != '3.12.0-rc.3'
run: |
# Install to collect dependencies into the (pip) cache.
pip install .[test]
Expand Down Expand Up @@ -230,7 +230,7 @@ jobs:
&& startsWith(github.ref, 'refs/tags')
&& startsWith(runner.os, 'Mac')
&& !startsWith(matrix.python-version, 'pypy')
&& !startsWith(matrix.python-version, '3.12.0-beta.4')
&& !startsWith(matrix.python-version, '3.12.0-rc.3')
env:
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
run: |
Expand All @@ -249,7 +249,7 @@ jobs:
- "3.9"
- "3.10"
- "3.11"
- "3.12.0-beta.4"
- "3.12.0-rc.3"
os: [ubuntu-20.04, macos-11]
exclude:
- os: macos-11
Expand Down Expand Up @@ -286,8 +286,8 @@ jobs:
with:
name: zope.index-${{ runner.os }}-${{ matrix.python-version }}.whl
path: dist/
- name: Install zope.index 3.12.0-beta.4
if: ${{ startsWith(matrix.python-version, '3.12.0-beta.4') }}
- name: Install zope.index 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
Expand All @@ -301,7 +301,7 @@ jobs:
# Python release may only be available as pre-releases
pip install --pre -U -e .[test]
- name: Install zope.index
if: ${{ !startsWith(matrix.python-version, '3.12.0-beta.4') }}
if: ${{ !startsWith(matrix.python-version, '3.12.0-rc.3') }}
run: |
pip install -U wheel setuptools
pip install -U coverage
Expand Down
3 changes: 2 additions & 1 deletion .meta.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# https://github.com/zopefoundation/meta/tree/master/config/c-code
[meta]
template = "c-code"
commit-id = "b99ba750"
commit-id = "b21fbbf2"

[python]
with-appveyor = true
Expand All @@ -21,6 +21,7 @@ fail-under = 99

[manifest]
additional-rules = [
"include *.yaml",
"include *.sh",
"recursive-include docs *.bat",
"recursive-include src *.rst",
Expand Down
25 changes: 25 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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: .
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -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 src *.rst
1 change: 0 additions & 1 deletion doc-requirements.txt

This file was deleted.

2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx
repoze.sphinx.autointerface

0 comments on commit 60dfedb

Please sign in to comment.