Skip to content

Commit

Permalink
Integrate .readthedocs.yaml (#262)
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Havlik authored Sep 22, 2023
1 parent 7fd02e2 commit c4adc51
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- ["3.9", "py39"]
- ["3.10", "py310"]
- ["3.11", "py311"]
- ["3.12.0-beta.2", "py312"]
- ["3.12.0-rc.3", "py312"]
- ["3.9", "docs"]
- ["3.9", "coverage"]
- ["3.9", "py39-datetime"]
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/pure-python
[meta]
template = "pure-python"
commit-id = "1814282a"
commit-id = "b21fbbf2"

[python]
with-pypy = false
Expand Down Expand Up @@ -66,6 +66,7 @@ additional-sources = "tests"

[manifest]
additional-rules = [
"include *.yaml",
"recursive-include docs *.ast",
"recursive-include docs *.bat",
"recursive-include docs *.jpg",
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/pure-python
# 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 @@ -12,6 +12,7 @@ recursive-include docs *.txt
recursive-include docs Makefile

recursive-include src *.py
include *.yaml
recursive-include docs *.ast
recursive-include docs *.bat
recursive-include docs *.jpg
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,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
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sphinx
4 changes: 4 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ envlist =

[testenv]
usedevelop = true
package = wheel
wheel_build_env = .pkg
pip_pre = py312: true
deps =
datetime: DateTime
Expand All @@ -25,6 +27,8 @@ deps =
Sphinx
setenv =
COVERAGE_FILE=.coverage.{envname}
py312: VIRTUALENV_PIP=23.1.2
py312: PIP_REQUIRE_VIRTUALENV=0
commands =
python -V
pytest --cov=src --cov=tests --cov-report= {posargs}
Expand Down

0 comments on commit c4adc51

Please sign in to comment.