summaryrefslogtreecommitdiffstats
path: root/.readthedocs.yml
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--.readthedocs.yml41
1 files changed, 41 insertions, 0 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 0000000..bb33e2e
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,41 @@
+# 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:
+ builder: html
+ configuration: docs/conf.py
+ fail_on_warning: true
+
+# Build documentation with MkDocs
+#mkdocs:
+# configuration: mkdocs.yml
+# fail_on_warning: true
+
+# Optionally build your docs in additional formats
+# such as PDF and ePub
+formats: []
+
+submodules:
+ include: all # []
+ exclude: []
+ recursive: true
+
+build:
+ image: latest
+
+# Optionally set the version of Python and requirements required
+# to build docs
+python:
+ version: 3.8
+ install:
+ - method: pip
+ path: .
+ - requirements: docs/requirements.txt
+ system_packages: false