Skip to content

Commit

Permalink
Integrate .readthedocs.yaml. (#24)
Browse files Browse the repository at this point in the history
* Integrate .readthedocs.yaml.

* Update docs/conf.py

---------

Co-authored-by: Daniel Havlik <dh@gocept.com>
Co-authored-by: Michael Howitz <icemac@gmx.net>
  • Loading branch information
3 people authored Feb 8, 2024
1 parent cfa8c5f commit 53e09aa
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 2 deletions.
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 = "f6bd0f55"
commit-id = "b21fbbf2"

[python]
with-sphinx-doctests = false
Expand All @@ -20,6 +20,7 @@ fail-under = 99

[manifest]
additional-rules = [
"include *.yaml",
"recursive-include src *.csv",
"recursive-include src *.gif",
"recursive-include src *.png",
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 src *.csv
recursive-include src *.gif
recursive-include src *.png
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Sphinx
repoze.sphinx.autointerface
zope.mimetype
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ignore =
force_single_line = True
combine_as_imports = True
sections = FUTURE,STDLIB,THIRDPARTY,ZOPE,FIRSTPARTY,LOCALFOLDER
known_third_party = six, docutils, pkg_resources, pytz
known_third_party = docutils, pkg_resources, pytz
known_zope =
known_first_party =
default_section = ZOPE
Expand Down
2 changes: 2 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ envlist =

[testenv]
usedevelop = true
package = wheel
wheel_build_env = .pkg
deps =
commands =
zope-testrunner --test-path=src {posargs:-vc}
Expand Down

0 comments on commit 53e09aa

Please sign in to comment.