RTD support

honno · Feb 26, 2022 · 0d4879d · 0d4879d
1 parent 14a9de3
commit 0d4879d
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 3 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,21 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
+
+sphinx:
+   configuration: conf.py
+
+formats:
+   - pdf
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
diff --git a/pyproject.toml b/pyproject.toml
@@ -11,14 +11,17 @@ license = "BSD-3-Clause"
 [tool.poetry.dependencies]
 python = ">=3.8,<3.10"
 bitarray = "^2.2.4"
-# some later version requires normalisation for chisquare values which I cba with
-scipy = "1.5.4"
+scipy = "1.5.4"  # TODO: don't pin a single version
 numpy = "^1.21.1"
+Sphinx = {version = "^4.4.0", optional = true}
+
+[tool.poetry.extras]
+# https://github.com/readthedocs/readthedocs.org/issues/4912#issuecomment-664002569
+docs = ["Sphinx"]
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.4"
 pre-commit = "^2.13.0"
-Sphinx = "^4.4.0"
 sphinx-autobuild = "^2021.3.14"
 
 [build-system]