From: Andrew Grimberg <agrimberg@linuxfoundation.org>
Date: Fri, 21 Jul 2023 12:58:54 +0000 (-0700)
Subject: CI: Add RTD configuration file
X-Git-Tag: v0.37.7~20
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=dc2972b5db1712dfe5be31fdc721abfc3dc02630;p=releng%2Flftools.git

CI: Add RTD configuration file

RTD will soon be requiring a configuration file for builds.
Additionally, they will soon stop honoring the unshallow feature flag
that they have on the repository and to get an unshallow checkout we
must do so via the config file

Issue: RELENG-4815
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
Change-Id: I41ae572570dcfb1b82a8457a5f008cb736ca3c0b
---

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 00000000..a49ea6e5
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,30 @@
+# 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
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# 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-docs.txt
+    - {path: ., method: pip}