3 # Job template for verifying Sphinx/Restructured Text for RTD
5 # The purpose of this job template is verify documentation source
10 # path: directory containing the project's tox.ini relative to
11 # the workspace. The default is the project root.
13 name: '{project-name}-{stream}-verify-rtd'
16 project-type: freestyle
22 build-days-to-keep: '{build-days-to-keep}'
28 refspec: 'refs/heads/{branch}'
29 artifacts: '{archive-artifacts}'
31 maven-version: '{maven-version}'
35 credentials-id: '{jenkins-ssh-credential}'
38 choosing-strategy: 'default'
40 - 'refs/heads/{branch}'
44 recursive: '{submodule-recursive}'
49 build-timeout: '{build-timeout}'
52 - gerrit-trigger-patch-submitted:
53 server: '{server-name}'
56 files: 'docs/**/*.rst'
61 if [ "$GERRIT_PROJECT" != "doc" ]; then
62 if [ -d docs/submodules/$GERRIT_PROJECT.git ]; then
63 cd docs/submodules/$GERRIT_PROJECT.git
65 cd docs/submodules/$GERRIT_PROJECT
67 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
69 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
71 - shell: !include-raw: doc-install-plantuml.sh
74 python3 -m venv $WORKSPACE/venv-tox
75 source $WORKSPACE/venv-tox/bin/activate
76 pip install --upgrade pip
77 pip install --upgrade tox argparse
81 mkdir -p "$WORKSPACE/archives"
82 mv docs/_build/html "$WORKSPACE/archives/"
86 maven-version: '{maven-version}'
89 # Job template for merging/publishing Sphinx/Restructured Text at RTD
91 # The purpose of this job template is to trigger updates after
92 # a merge of documentation source in gerrit
96 # rtdproject: name of a project at readthedocs.io
98 # path: directory containing the project's tox.ini relative to
99 # the workspace. The default is the project root.
101 name: '{project-name}-{stream}-merge-rtd'
104 project-type: freestyle
110 build-days-to-keep: '{build-days-to-keep}'
116 refspec: 'refs/heads/{branch}'
117 artifacts: '{archive-artifacts}'
119 maven-version: '{maven-version}'
123 credentials-id: '{jenkins-ssh-credential}'
126 choosing-strategy: 'default'
128 - 'refs/heads/{branch}'
131 submodule-recursive: '{submodule-recursive}'
136 build-timeout: '{build-timeout}'
137 - credentials-binding:
139 credential-id: docs-token
140 variable: DOCS_RTD_TOKEN
144 server-name: '{server-name}'
146 - change-merged-event
147 - comment-added-contains-event:
148 comment-contains-value: 'remerge'
150 - project-compare-type: 'ANT'
151 project-pattern: '**'
153 - branch-compare-type: 'ANT'
154 branch-pattern: '**/{branch}'
157 pattern: docs/**/*.rst
160 - shell: !include-raw: doc-post-rtd.sh
164 maven-version: '{maven-version}'