Add RTD Configuration file
authorTrevor Bramwell <tbramwell@linuxfoundation.org>
Tue, 29 Jun 2021 18:17:47 +0000 (11:17 -0700)
committerTrevor Bramwell <tbramwell@linuxfoundation.org>
Tue, 29 Jun 2021 19:46:36 +0000 (12:46 -0700)
Builds for the master branch broke on RTD broke with the move of the
requirements.txt file from etc/. Updating the path on RTD for
requirements fixes this, but at the cost of breaking all the historic
stable branch builds.

Using .readthedocs.yml the branch can be configured with it's own
location for requirements separate from the global configuration.

The setting to disable cloning of submodules is also included in this
configuration.

Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
.readthedocs.yml [new file with mode: 0644]

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644 (file)
index 0000000..e24c076
--- /dev/null
@@ -0,0 +1,15 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+---
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+submodules:
+  exclude: all
+
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt