Skip to content

Commit

Permalink
Integrate .readthedocs.yaml (#27)
Browse files Browse the repository at this point in the history
Done using zopefoundation/meta#205.

---------

Co-authored-by: Daniel Havlik <dh@gocept.com>
  • Loading branch information
Michael Howitz and Daniel Havlik authored Sep 22, 2023
1 parent d80e6fe commit 2bc65fe
Show file tree
Hide file tree
Showing 7 changed files with 37 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/zope-product
[meta]
template = "zope-product"
commit-id = "297a7d23"
commit-id = "b21fbbf2"

[python]
with-pypy = false
Expand All @@ -27,6 +27,7 @@ additional-config = [

[manifest]
additional-rules = [
"include *.yaml",
"recursive-include src *.dtml",
"recursive-include src *.gif",
"recursive-include src *.pt",
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/zope-product
# 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 *.dtml
recursive-include src *.gif
recursive-include src *.pt
Expand Down
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. image:: https://readthedocs.org/projects/productsdcworkflow/badge/?version=latest
:target: https://productsdcworkflow.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://github.com/zopefoundation/Products.DCWorkflow/workflows/tests/badge.svg
:target: https://github.com/zopefoundation/Products.DCWorkflow/actions?query=workflow%3Atests

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
pkginfo
repoze.sphinx.autointerface
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,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 = Products.CMFCore
default_section = ZOPE
Expand Down
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ commands =
basepython = python3
skip_install = true
allowlist_externals =
{[testenv]allowlist_externals}
mkdir
deps =
{[testenv]deps}
Expand Down

0 comments on commit 2bc65fe

Please sign in to comment.