#
# 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"
+ STABLE_BRANCH: "stable/*"
.docs-cache: &docs-cache
paths:
- 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:
rules:
- if: $CI_PIPELINE_SOURCE == "schedule" && $DOCS_SCHEDULE != "true"
when: never
- - if: $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+ - if: $CI_PIPELINE_SOURCE == "merge_request_event"
changes:
- $DOCS_DIRECTORY/**/*
+ - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+ - if: $CI_COMMIT_BRANCH == $STABLE_BRANCH
docs-link-check:
stage: test
rules:
- if: $CI_PIPELINE_SOURCE == "schedule" && $DOCS_SCHEDULE != "true"
when: never
- - if: $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+ - if: $CI_PIPELINE_SOURCE == "merge_request_event"
changes:
- $DOCS_DIRECTORY/**/*
+ - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+ - if: $CI_COMMIT_BRANCH == $STABLE_BRANCH
pages:
stage: deploy