From 1e1d2badbf587f3622ffef099503f324750f9da0 Mon Sep 17 00:00:00 2001 From: John Marshall Date: Tue, 15 Aug 2023 22:06:59 +1200 Subject: [PATCH] Add .readthedocs.yaml configuration file Read the Docs will soon require this configuration file to be used. Rename requirements.txt to reflect that it contains *development* requirements. We still only really need it for readthedocs -- other tools (e.g. cibuildwheel) mostly read pyproject.toml. --- .readthedocs.yaml | 22 ++++++++++++++++++++++ doc/requirements-rtd.txt | 2 ++ requirements.txt => requirements-dev.txt | 0 3 files changed, 24 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 doc/requirements-rtd.txt rename requirements.txt => requirements-dev.txt (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..4ab1f7b2b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +python: + install: + - requirements: requirements-dev.txt + - requirements: doc/requirements-rtd.txt + - method: setuptools + path: . + +sphinx: + builder: html + configuration: doc/conf.py + +formats: + - epub + - htmlzip + - pdf diff --git a/doc/requirements-rtd.txt b/doc/requirements-rtd.txt new file mode 100644 index 000000000..53fc1f32e --- /dev/null +++ b/doc/requirements-rtd.txt @@ -0,0 +1,2 @@ +sphinx==7.1.2 +sphinx-rtd-theme==1.3.0rc1 diff --git a/requirements.txt b/requirements-dev.txt similarity index 100% rename from requirements.txt rename to requirements-dev.txt