Skip to content

Commit

Permalink
Add readthedocs.yaml (#22)
Browse files Browse the repository at this point in the history
* Add badge

---------

Co-authored-by: Michael Howitz <mh@gocept.com>
  • Loading branch information
Daniel Havlik and Michael Howitz committed Sep 21, 2023
1 parent de43fe6 commit e3ecb8f
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 3 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 = "b99ba750"
commit-id = "f6f126ea"

[python]
with-pypy = true
Expand All @@ -28,6 +28,7 @@ ignore-bad-ideas = [

[manifest]
additional-rules = [
"include *.yaml",
"recursive-include src *.po",
"recursive-include src *.pot",
"recursive-include src *.txt",
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 *.po
recursive-include src *.pot
recursive-include src *.txt
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/z3cschema/badge/?version=latest
:target: https://z3cschema.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

This package provides different additional Zope 3 schema fields.

The provided fields include support for:
Expand Down
3 changes: 1 addition & 2 deletions doc-requirements.txt → docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
pip>=8.1.2
setuptools>=23.0.0
Sphinx
repoze.sphinx.autointerface
sphinx_rtd_theme

0 comments on commit e3ecb8f

Please sign in to comment.