summaryrefslogtreecommitdiff
path: root/.readthedocs.yml
diff options
context:
space:
mode:
authorCarlton Gibson <carlton.gibson@noumenal.es>2021-11-03 11:42:00 +0100
committerCarlton Gibson <carlton@noumenal.es>2021-11-03 12:28:20 +0100
commit0da7a2e9dab81b622a2000536c6a96de7f46e237 (patch)
tree44cd98227a9cd00387839c69d733b7a2c550deee /.readthedocs.yml
parenta697424969f7f464bf6492b09a6cdac135499e02 (diff)
Fixed #33247 -- Added configuration for Read The Docs.
Co-authored-by: Andrew Neitsch <andrew@neitsch.ca>
Diffstat (limited to '.readthedocs.yml')
-rw-r--r--.readthedocs.yml18
1 files changed, 18 insertions, 0 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 0000000000..d6ca0316b3
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,18 @@
+# Configuration for the Read The Docs (RTD) builds of the documentation.
+# Ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
+# Note python.install.requirements is not currently required, as Sphinx is
+# preinstalled and spelling checks not performed by RTD.
+version: 2
+
+build:
+ os: ubuntu-20.04
+ tools:
+ python: "3.10"
+
+sphinx:
+ configuration: docs/conf.py
+
+formats:
+ - epub
+ - pdf
+ - htmlzip