CI: Update RTD configuration file 03/107403/1
authorAnil Belur <abelur@linuxfoundation.org>
Mon, 24 Jul 2023 13:09:02 +0000 (23:09 +1000)
committerGuillaume Lambert <guillaume.lambert@orange.com>
Tue, 29 Aug 2023 08:55:01 +0000 (08:55 +0000)
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: LF-JIRA RELENG-4815
Change-Id: I3ac4b43874a875f79340329613f549e484b9f93f
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
(cherry picked from commit 8e4c6bb7557f639ad8ee8b48879cd27f498cb1e4)

.readthedocs.yml

index 5ff506fb920270f2b955338bb9d99e990c407115..325247c98b7328ef228411ac60a987c93cd4e3c1 100644 (file)
@@ -8,7 +8,22 @@ version: 2
 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:
-    version: 3.7
-    install:
-        - requirements: docs/requirements.txt
+  install:
+    - requirements: docs/requirements.txt