From: Trevor Bramwell <tbramwell@linuxfoundation.org>
Date: Mon, 28 Jun 2021 22:01:41 +0000 (-0700)
Subject: Add DOCS_REQIREMENTS variable to RTD Gitlab job
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=commitdiff_plain;h=0d063a44983220bf4c9f92cbf820374bfaa13845

Add DOCS_REQIREMENTS variable to RTD Gitlab job

This will allow requirements.txt to exist at any arbitrary path in the
repository and not solely under the documentation root.

Change-Id: I48ec620d3afb09d509e6b4e9fae54da1b7cb217a
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
---

diff --git a/gitlab-templates/RTD.gitlab-ci.yml b/gitlab-templates/RTD.gitlab-ci.yml
index 5b838d204..5e2f55b82 100644
--- a/gitlab-templates/RTD.gitlab-ci.yml
+++ b/gitlab-templates/RTD.gitlab-ci.yml
@@ -19,10 +19,14 @@
 #
 # Scheduled builds can be enabled when creating a schedule job and
 # specifying DOCS_SCHEDULE = "true" in build variables
+#
+# If extra dependencies are needed for builds they will be installed
+# from the $DOCS_REQUIREMENTS location.
 ---
 variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
   DOCS_DIRECTORY: "docs"
+  DOCS_REQUIREMENTS: "$DOCS_DIRECTORY/requirements.txt"
 
 .docs-cache: &docs-cache
   paths:
@@ -36,8 +40,8 @@ variables:
   - source venv/bin/activate
   - pip install Sphinx
   - |
-    if [ -f "$DOCS_DIRECTORY/requirements.txt" ]; then
-      pip install -r "$DOCS_DIRECTORY/requirements.txt"
+    if [ -f "$DOCS_REQUIREMENTS" ]; then
+      pip install -r "$DOCS_REQUIREMENTS"
     fi
 
 docs-build: