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
73 virtualenv $WORKSPACE/venv-tox
74 source $WORKSPACE/venv-tox/bin/activate
75 pip install --upgrade pip
76 pip install --upgrade tox argparse
80 mkdir -p "$WORKSPACE/archives"
81 mv docs/_build/html "$WORKSPACE/archives/"
85 maven-version: '{maven-version}'
88 # Job template for merging/publishing Sphinx/Restructured Text at RTD
90 # The purpose of this job template is to trigger updates after
91 # a merge of documentation source in gerrit
95 # rtdproject: name of a project at readthedocs.io
97 # path: directory containing the project's tox.ini relative to
98 # the workspace. The default is the project root.
100 name: '{project-name}-{stream}-merge-rtd'
103 project-type: freestyle
109 build-days-to-keep: '{build-days-to-keep}'
115 refspec: 'refs/heads/{branch}'
116 artifacts: '{archive-artifacts}'
118 maven-version: '{maven-version}'
122 credentials-id: '{jenkins-ssh-credential}'
125 choosing-strategy: 'default'
127 - 'refs/heads/{branch}'
130 submodule-recursive: '{submodule-recursive}'
135 build-timeout: '{build-timeout}'
139 server-name: '{server-name}'
141 - change-merged-event
142 - comment-added-contains-event:
143 comment-contains-value: 'remerge'
145 - project-compare-type: 'ANT'
146 project-pattern: '**'
148 - branch-compare-type: 'ANT'
149 branch-pattern: '**/{branch}'
152 pattern: docs/**/*.rst
155 - shell: !include-raw: doc-post-rtd.sh
159 maven-version: '{maven-version}'