blob: 5e2f55b82ec0a636f0f06734e26358de2b3d226a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
# ReadTheDocs Workflow
#
# This workflow adds these builds to projects:
#
# docs-build:
# Generate a html sphinx-build from the $DOCS_DIRECTORY
#
# docs-link-check:
# Run a non-blocking sphinx-build linkcheck against
# the $DOCS_DIRECTORY
#
# pages:
# Serve the built documentation as the Gitlab Pages site for
# the project
#
# Both docs-build and docs-link-check run on merge requests and merges
# to the default branch that modify files under the $DOCS_DIRECTORY,
# while pages only run on merges.
#
# 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:
- .cache/pip
- venv/
.docs-before-script: &docs-before-script
- python -V
- pip install virtualenv
- virtualenv venv
- source venv/bin/activate
- pip install Sphinx
- |
if [ -f "$DOCS_REQUIREMENTS" ]; then
pip install -r "$DOCS_REQUIREMENTS"
fi
docs-build:
stage: build
image: python:3
before_script:
- *docs-before-script
script: |
sphinx-build -T -b html -D language=en $DOCS_DIRECTORY _build/html
cache: *docs-cache
artifacts:
paths:
- _build/html
rules:
- if: $CI_PIPELINE_SOURCE == "schedule" && $DOCS_SCHEDULE != "true"
when: never
- if: $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
changes:
- $DOCS_DIRECTORY/*
docs-link-check:
stage: test
allow_failure: true
needs: []
image: python:3
before_script:
- *docs-before-script
script: |
sphinx-build -T -b linkcheck $DOCS_DIRECTORY _build/linkcheck
cache: *docs-cache
artifacts:
paths:
- _build/linkcheck
rules:
- if: $CI_PIPELINE_SOURCE == "schedule" && $DOCS_SCHEDULE != "true"
when: never
- if: $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
changes:
- $DOCS_DIRECTORY/*
pages:
stage: deploy
image: python:3
script: |
mkdir public
mv _build/html/* public/
artifacts:
paths:
- public
rules:
- if: $CI_PIPELINE_SOURCE == "schedule"
when: never
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
changes:
- $DOCS_DIRECTORY/*
|
