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}'
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 if [ -d docs/submodules/$GERRIT_PROJECT.git ]; then
62 cd docs/submodules/$GERRIT_PROJECT.git
64 cd docs/submodules/$GERRIT_PROJECT
66 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
68 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
72 virtualenv $WORKSPACE/venv-tox
73 source $WORKSPACE/venv-tox/bin/activate
74 pip install --upgrade pip
75 pip install --upgrade tox argparse
82 maven-version: '{maven-version}'
85 # Job template for merging/publishing Sphinx/Restructured Text at RTD
87 # The purpose of this job template is to trigger updates after
88 # a merge of documentation source in gerrit
92 # rtdproject: name of a project at readthedocs.io
94 # path: directory containing the project's tox.ini relative to
95 # the workspace. The default is the project root.
97 name: '{project-name}-{stream}-merge-rtd'
100 project-type: freestyle
106 build-days-to-keep: '{build-days-to-keep}'
112 refspec: 'refs/heads/{branch}'
113 artifacts: '{archive-artifacts}'
115 maven-version: '{maven-version}'
119 credentials-id: '{jenkins-ssh-credential}'
122 choosing-strategy: 'default'
124 - 'refs/heads/{branch}'
127 submodule-recursive: '{submodule-recursive}'
132 build-timeout: '{build-timeout}'
136 server-name: '{server-name}'
138 - change-merged-event
139 - comment-added-contains-event:
140 comment-contains-value: 'remerge'
142 - project-compare-type: 'ANT'
143 project-pattern: '**'
145 - branch-compare-type: 'ANT'
146 branch-pattern: '**/{branch}'
149 pattern: docs/**/*.rst
152 - shell: !include-raw: doc-post-rtd.sh
156 maven-version: '{maven-version}'