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.
pysam-developers · Aug 15, 2023 · 1e1d2ba · 1e1d2ba
1 parent 2abc62d
commit 1e1d2ba
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/.readthedocs.yaml 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
@@ -0,0 +1,2 @@
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1
diff --git a/requirements.txt → requirements-dev.txt b/requirements.txt → requirements-dev.txt