From e3ecb8f013a5aab9b3f2dcf5268372d1c923e021 Mon Sep 17 00:00:00 2001 From: Daniel Havlik Date: Thu, 21 Sep 2023 16:21:04 +0200 Subject: [PATCH] Add readthedocs.yaml (#22) * Add badge --------- Co-authored-by: Michael Howitz --- .meta.toml | 3 ++- .readthedocs.yaml | 25 +++++++++++++++++++ MANIFEST.in | 1 + README.rst | 4 +++ doc-requirements.txt => docs/requirements.txt | 3 +-- 5 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yaml rename doc-requirements.txt => docs/requirements.txt (60%) diff --git a/.meta.toml b/.meta.toml index 99fe9d7..40789ee 100644 --- a/.meta.toml +++ b/.meta.toml @@ -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 @@ -28,6 +28,7 @@ ignore-bad-ideas = [ [manifest] additional-rules = [ + "include *.yaml", "recursive-include src *.po", "recursive-include src *.pot", "recursive-include src *.txt", diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6794188 --- /dev/null +++ b/.readthedocs.yaml @@ -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: . \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in index 2f84168..3e4befa 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -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 diff --git a/README.rst b/README.rst index 5538536..cdc47fa 100644 --- a/README.rst +++ b/README.rst @@ -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: diff --git a/doc-requirements.txt b/docs/requirements.txt similarity index 60% rename from doc-requirements.txt rename to docs/requirements.txt index 5429a4e..2d402fc 100644 --- a/doc-requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,3 @@ -pip>=8.1.2 -setuptools>=23.0.0 +Sphinx repoze.sphinx.autointerface sphinx_rtd_theme