summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTrevor Bramwell <tbramwell@linuxfoundation.org>2021-06-29 11:17:47 -0700
committerTrevor Bramwell <tbramwell@linuxfoundation.org>2021-06-29 12:46:36 -0700
commit4def62fe1cb1c65b98e449a79ec05bfd2f5fce36 (patch)
tree271a9359445b29a378bd3ff84f057e37dc68c015
parentbccd88ef95f02d1c47acf0fba9c6d2d1c7408540 (diff)
Add RTD Configuration file
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>
-rw-r--r--.readthedocs.yml15
1 files changed, 15 insertions, 0 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 000000000..e24c07619
--- /dev/null
+++ b/.readthedocs.yml
@@ -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