From: Ryota MIBU <r-mibu@cq.jp.nec.com>
Date: Thu, 28 Jan 2016 14:54:45 +0000 (+0900)
Subject: docs: create new job for yardstick autodocs
X-Git-Tag: brahmaputra.1.0~83
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=bdcbaf0afc5d704eb9d3099f83eb7ebcfa6582ff;p=releng.git

docs: create new job for yardstick autodocs

Yardstick needs packages installed to build document using docstring,
so this patch adds new document builder in yardstick project jobs
and removes yardstick from opnfv-docs jobs.

We should consider to support venv or tox when aother project wants to
use various python packages for their document build.

Change-Id: I453b0dec02a450e338a1bb379ce790e9ddaf8083
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
---

diff --git a/jjb/opnfv/opnfv-docs.yml b/jjb/opnfv/opnfv-docs.yml
index 296424344..eb6e58b92 100644
--- a/jjb/opnfv/opnfv-docs.yml
+++ b/jjb/opnfv/opnfv-docs.yml
@@ -53,7 +53,7 @@
             projects:
               - project-compare-type: 'REG_EXP'
 #Left out arno projects oscar|octopus|functest|genesis
-                project-pattern: 'vswitchperf|yardstick|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|octopus|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|cperf|functest'
+                project-pattern: 'vswitchperf|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|octopus|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|cperf|functest'
                 branches:
                   - branch-compare-type: 'ANT'
                     branch-pattern: '**/{branch}'
@@ -91,7 +91,7 @@
                     comment-contains-value: 'remerge'
             projects:
               - project-compare-type: 'REG_EXP'
-                project-pattern: 'vswitchperf|yardstick|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|octopus|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|cperf|functest'
+                project-pattern: 'vswitchperf|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|octopus|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|cperf|functest'
                 branches:
                   - branch-compare-type: 'ANT'
                     branch-pattern: '**/{branch}'
diff --git a/jjb/yardstick/yardstick-project-jobs.yml b/jjb/yardstick/yardstick-project-jobs.yml
index aa02c8752..426557a0a 100644
--- a/jjb/yardstick/yardstick-project-jobs.yml
+++ b/jjb/yardstick/yardstick-project-jobs.yml
@@ -71,6 +71,8 @@
             python setup.py develop
             ./run_tests.sh
             deactivate
+        - generate-api-docs-for-yardstick
+        - upload-review-docs
 
 - job-template:
     name: 'yardstick-merge-{stream}'
@@ -81,6 +83,10 @@
         - gerrit-parameter:
             branch: '{branch}'
         - 'ericsson-build-defaults'
+        - string:
+            name: GS_URL
+            default: '$GS_BASE{gs-pathname}'
+            description: "Directory where the build artifact will be located upon the completion     of the build."
 
     scm:
         - gerrit-trigger-scm:
@@ -115,3 +121,21 @@
             python setup.py develop
             ./run_tests.sh
             deactivate
+        - generate-api-docs-for-yardstick
+        - upload-merged-docs
+
+################################
+# job builders
+################################
+
+- builder:
+    name: generate-api-docs-for-yardstick
+    builders:
+        - shell: |
+            #!/bin/bash
+            set -o errexit
+            set -o pipefail
+
+            source $WORKSPACE/yardstick_venv/bin/activate
+            sphinx-apidoc -o docs/apidocs yardstick
+            deactivate