Docs: Add RTD config file 89/71989/1
authorAndrew Grimberg <agrimberg@linuxfoundation.org>
Mon, 24 Jul 2023 15:17:23 +0000 (08:17 -0700)
committerAndrew Grimberg <agrimberg@linuxfoundation.org>
Mon, 24 Jul 2023 15:17:23 +0000 (08:17 -0700)
RTD will start requiring configuration files on September 25, 2023.
This also makes sure that we properly unshallow the clone as that is a
feature flag that is going away as well.

Issue: RELENG-4816
Change-Id: Ia3015cd6f519158ac03ddcb3453d3ac4fb233d51
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
.readthedocs.yml [new file with mode: 0644]

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644 (file)
index 0000000..9cd1c3a
--- /dev/null
@@ -0,0 +1,28 @@
+---
+# 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:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
+
+python:
+  install:
+    - requirements: requirements.txt
+    - path: .
+      method: pip