configure Read the Docs

tendenci · Dec 15, 2021 · 3d54a1c · 3d54a1c
1 parent 5ff3186
commit 3d54a1c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -20,8 +20,9 @@ _notes/
 __pycache__/
 *.pyc
 
-# except for .gitignore
+# except for .gitignore and .readthedocs.yml
 !/.gitignore
+!.readthedocs.yml
 
 # except for .tx/config
 !/.tx/

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,16 @@
+# Configuration for the Read The Docs (RTD) builds of the documentation.
+# Ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
+# The python.install.requirements pins the version of Sphinx used.
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+Sphinx>=4.3.1