Skip to content

Commit

Permalink
Integrate .readthedocs.yaml, done using zopefoundation/meta#205.
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Havlik committed Sep 22, 2023
1 parent c2ceef5 commit b4ed01e
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 10 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-alpha.7"
- "3.12.0-rc.3"
os: [ubuntu-20.04, macos-11]
exclude:
- os: macos-11
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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: |
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
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 = "fe63cb4c"
commit-id = "b21fbbf2"

[python]
with-appveyor = true
Expand Down Expand Up @@ -41,6 +41,7 @@ fail-under = 93

[manifest]
additional-rules = [
"include *.yaml",
"include *.sh",
"recursive-include docs *.bat",
"recursive-include docs *.css",
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 docs *.css
Expand Down
5 changes: 5 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Sphinx>4.3
sphinx-rtd-theme>=1
ZConfig
Zope
tempstorage
2 changes: 2 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b4ed01e

Please sign in to comment.