refactor(all): installation with RTD Closes #35

rundherum · Oct 16, 2020 · 0e41c1f · 0e41c1f
1 parent 9f077a6
commit 0e41c1f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 10 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build the docs in additional formats such as PDF
+formats:
+  - epub
+  - htmlzip
+  - pdf
+
+# Set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+      - requirements: docs/rtd-requirements.txt
+      - requirements: requirements.txt
diff --git a/docs/rtd-requirements.txt b/docs/rtd-requirements.txt
@@ -0,0 +1,4 @@
+# packages needed for building on readthedocs.io
+
+nbsphinx >= 0.7.1
+sphinx-copybutton >= 0.2.12
diff --git a/docs/rtfd-requirements.txt b/docs/rtfd-requirements.txt