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: 'gerrit'
40 - 'origin/$GERRIT_BRANCH'
44 recursive: '{submodule-recursive}'
48 build-timeout: '{build-timeout}'
51 - gerrit-trigger-patch-submitted:
52 server: '{server-name}'
55 files: 'docs/**/*.rst'
60 if [ "$GERRIT_PROJECT" != "doc" ]; then
61 cd docs/submodules/$GERRIT_PROJECT
62 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
64 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
68 virtualenv $WORKSPACE/venv-tox
69 source $WORKSPACE/venv-tox/bin/activate
70 pip install --upgrade pip
71 pip install --upgrade tox argparse
78 maven-version: '{maven-version}'
81 # Job template for merging/publishing Sphinx/Restructured Text at RTD
83 # The purpose of this job template is to trigger updates after
84 # a merge of documentation source in gerrit
88 # rtdproject: name of a project at readthedocs.io
90 # path: directory containing the project's tox.ini relative to
91 # the workspace. The default is the project root.
93 name: '{project-name}-{stream}-merge-rtd'
96 project-type: freestyle
102 build-days-to-keep: '{build-days-to-keep}'
108 refspec: 'refs/heads/{branch}'
109 artifacts: '{archive-artifacts}'
111 maven-version: '{maven-version}'
115 credentials-id: '{jenkins-ssh-credential}'
118 choosing-strategy: 'gerrit'
120 - 'refs/heads/{branch}'
123 submodule-recursive: '{submodule-recursive}'
128 build-timeout: '{build-timeout}'
132 server-name: '{server-name}'
134 - change-merged-event
135 - comment-added-contains-event:
136 comment-contains-value: 'remerge'
138 - project-compare-type: 'ANT'
139 project-pattern: '**'
141 - branch-compare-type: 'ANT'
142 branch-pattern: '**/{branch}'
145 pattern: docs/**/*.rst
148 - shell: !include-raw: doc-post-rtd.sh
152 maven-version: '{maven-version}'