on GitLab at https://gitlab.com/anuket/opnfvdocs</title>
<meta name='generator' content='cgit 1.2.3-korg'/>
<meta name='robots' content='noindex, nofollow'/>
<link rel='stylesheet' type='text/css' href='/cgit-data/cgit.css'/>
<script type='text/javascript' src='/cgit.js'></script>
<link rel='shortcut icon' href='/favicon.ico'/>
<link rel='alternate' title='Atom feed' href='http://git.opnfv.org/opnfvdocs/atom/scripts/docs-build.sh?h=stable/danube' type='application/atom+xml'/>
<link rel='vcs-git' href='https://git.opnfv.org/opnfvdocs' title='opnfvdocs Git repository'/>
</head>
<body>
<div id="lfcollabprojects-header">
  <div class="gray-diagonal">
    <div class="header-inner">
      <a
        id="lfcollabprojects-logo"
        href="http://collabprojects.linuxfoundation.org"
        >Linux Foundation Collaborative Projects</a
      >
    </div>
  </div>
</div>
<div id='cgit'><table id='header'>
<tr>
<td class='logo' rowspan='2'><a href='/'><img src='/cgit-data/cgit.png' alt='cgit logo'/></a></td>
<td class='main'><a href='/'>index</a> : <a href='/opnfvdocs/'>opnfvdocs</a></td><td class='form'><form method='get'>
<input type='hidden' name='id' value='017c0bc36a21be91189db868fa1d006627f793c4'/><select name='h' onchange='this.form.submit();'>
<option value='master'>master</option>
<option value='stable/arno'>stable/arno</option>
<option value='stable/brahmaputra'>stable/brahmaputra</option>
<option value='stable/colorado'>stable/colorado</option>
<option value='stable/danube' selected='selected'>stable/danube</option>
<option value='stable/euphrates'>stable/euphrates</option>
<option value='stable/fraser'>stable/fraser</option>
<option value='stable/gambia'>stable/gambia</option>
<option value='stable/hunter'>stable/hunter</option>
<option value='stable/iruya'>stable/iruya</option>
<option value='stable/jerma'>stable/jerma</option>
<option value='stable/kali'>stable/kali</option>
<option value='stable/lakelse'>stable/lakelse</option>
<option value='stable/moselle'>stable/moselle</option>
<option value='stable/nile'>stable/nile</option>
<option value='stable/orinoco'>stable/orinoco</option>
<option value='stable/pieman'>stable/pieman</option>
</select> <input type='submit' value='switch'/></form></td></tr>
<tr><td class='sub'>Documentation for OPNFV releases - Now on GitLab at https://gitlab.com/anuket/opnfvdocs</td><td class='sub right'>Grokmirror user</td></tr></table>
<table class='tabs'><tr><td>
<a href='/opnfvdocs/?h=stable/danube'>summary</a><a href='/opnfvdocs/refs/?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>refs</a><a href='/opnfvdocs/log/scripts/docs-build.sh?h=stable/danube'>log</a><a class='active' href='/opnfvdocs/tree/scripts/docs-build.sh?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>tree</a><a href='/opnfvdocs/commit/scripts/docs-build.sh?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>commit</a><a href='/opnfvdocs/diff/scripts/docs-build.sh?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>diff</a><a href='/opnfvdocs/stats/scripts/docs-build.sh?h=stable/danube'>stats</a></td><td class='form'><form class='right' method='get' action='/opnfvdocs/log/scripts/docs-build.sh'>
<input type='hidden' name='h' value='stable/danube'/><input type='hidden' name='id' value='017c0bc36a21be91189db868fa1d006627f793c4'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/opnfvdocs/tree/?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>root</a>/<a href='/opnfvdocs/tree/scripts?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>scripts</a>/<a href='/opnfvdocs/tree/scripts/docs-build.sh?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>docs-build.sh</a></div><div class='content'>blob: 69f962505d852320488bcb7f7100690b8a398b83 (<a href='/opnfvdocs/plain/scripts/docs-build.sh?h=stable/danube&amp;id=017c0bc36a21be91189db868fa1d006627f793c4'>plain</a>)
<table summary='blob content' class='blob'>
<tr><td class='linenumbers'><pre><a id='n1' href='#n1'>1</a>
<a id='n2' href='#n2'>2</a>
<a id='n3' href='#n3'>3</a>
<a id='n4' href='#n4'>4</a>
<a id='n5' href='#n5'>5</a>
<a id='n6' href='#n6'>6</a>
<a id='n7' href='#n7'>7</a>
<a id='n8' href='#n8'>8</a>
<a id='n9' href='#n9'>9</a>
<a id='n10' href='#n10'>10</a>
<a id='n11' href='#n11'>11</a>
<a id='n12' href='#n12'>12</a>
<a id='n13' href='#n13'>13</a>
<a id='n14' href='#n14'>14</a>
<a id='n15' href='#n15'>15</a>
<a id='n16' href='#n16'>16</a>
<a id='n17' href='#n17'>17</a>
<a id='n18' href='#n18'>18</a>
<a id='n19' href='#n19'>19</a>
<a id='n20' href='#n20'>20</a>
<a id='n21' href='#n21'>21</a>
<a id='n22' href='#n22'>22</a>
<a id='n23' href='#n23'>23</a>
<a id='n24' href='#n24'>24</a>
<a id='n25' href='#n25'>25</a>
<a id='n26' href='#n26'>26</a>
<a id='n27' href='#n27'>27</a>
<a id='n28' href='#n28'>28</a>
<a id='n29' href='#n29'>29</a>
<a id='n30' href='#n30'>30</a>
<a id='n31' href='#n31'>31</a>
<a id='n32' href='#n32'>32</a>
<a id='n33' href='#n33'>33</a>
<a id='n34' href='#n34'>34</a>
<a id='n35' href='#n35'>35</a>
<a id='n36' href='#n36'>36</a>
<a id='n37' href='#n37'>37</a>
<a id='n38' href='#n38'>38</a>
<a id='n39' href='#n39'>39</a>
<a id='n40' href='#n40'>40</a>
<a id='n41' href='#n41'>41</a>
<a id='n42' href='#n42'>42</a>
<a id='n43' href='#n43'>43</a>
<a id='n44' href='#n44'>44</a>
<a id='n45' href='#n45'>45</a>
<a id='n46' href='#n46'>46</a>
<a id='n47' href='#n47'>47</a>
<a id='n48' href='#n48'>48</a>
<a id='n49' href='#n49'>49</a>
<a id='n50' href='#n50'>50</a>
<a id='n51' href='#n51'>51</a>
<a id='n52' href='#n52'>52</a>
<a id='n53' href='#n53'>53</a>
<a id='n54' href='#n54'>54</a>
<a id='n55' href='#n55'>55</a>
<a id='n56' href='#n56'>56</a>
<a id='n57' href='#n57'>57</a>
<a id='n58' href='#n58'>58</a>
<a id='n59' href='#n59'>59</a>
<a id='n60' href='#n60'>60</a>
<a id='n61' href='#n61'>61</a>
<a id='n62' href='#n62'>62</a>
<a id='n63' href='#n63'>63</a>
<a id='n64' href='#n64'>64</a>
<a id='n65' href='#n65'>65</a>
<a id='n66' href='#n66'>66</a>
<a id='n67' href='#n67'>67</a>
<a id='n68' href='#n68'>68</a>
<a id='n69' href='#n69'>69</a>
<a id='n70' href='#n70'>70</a>
<a id='n71' href='#n71'>71</a>
<a id='n72' href='#n72'>72</a>
<a id='n73' href='#n73'>73</a>
<a id='n74' href='#n74'>74</a>
<a id='n75' href='#n75'>75</a>
<a id='n76' href='#n76'>76</a>
<a id='n77' href='#n77'>77</a>
<a id='n78' href='#n78'>78</a>
<a id='n79' href='#n79'>79</a>
<a id='n80' href='#n80'>80</a>
<a id='n81' href='#n81'>81</a>
<a id='n82' href='#n82'>82</a>
<a id='n83' href='#n83'>83</a>
<a id='n84' href='#n84'>84</a>
<a id='n85' href='#n85'>85</a>
<a id='n86' href='#n86'>86</a>
<a id='n87' href='#n87'>87</a>
<a id='n88' href='#n88'>88</a>
<a id='n89' href='#n89'>89</a>
<a id='n90' href='#n90'>90</a>
<a id='n91' href='#n91'>91</a>
<a id='n92' href='#n92'>92</a>
<a id='n93' href='#n93'>93</a>
<a id='n94' href='#n94'>94</a>
<a id='n95' href='#n95'>95</a>
<a id='n96' href='#n96'>96</a>
<a id='n97' href='#n97'>97</a>
<a id='n98' href='#n98'>98</a>
<a id='n99' href='#n99'>99</a>
<a id='n100' href='#n100'>100</a>
<a id='n101' href='#n101'>101</a>
<a id='n102' href='#n102'>102</a>
<a id='n103' href='#n103'>103</a>
<a id='n104' href='#n104'>104</a>
<a id='n105' href='#n105'>105</a>
<a id='n106' href='#n106'>106</a>
<a id='n107' href='#n107'>107</a>
<a id='n108' href='#n108'>108</a>
<a id='n109' href='#n109'>109</a>
<a id='n110' href='#n110'>110</a>
<a id='n111' href='#n111'>111</a>
<a id='n112' href='#n112'>112</a>
<a id='n113' href='#n113'>113</a>
<a id='n114' href='#n114'>114</a>
<a id='n115' href='#n115'>115</a>
<a id='n116' href='#n116'>116</a>
<a id='n117' href='#n117'>117</a>
<a id='n118' href='#n118'>118</a>
<a id='n119' href='#n119'>119</a>
<a id='n120' href='#n120'>120</a>
<a id='n121' href='#n121'>121</a>
<a id='n122' href='#n122'>122</a>
<a id='n123' href='#n123'>123</a>
<a id='n124' href='#n124'>124</a>
<a id='n125' href='#n125'>125</a>
<a id='n126' href='#n126'>126</a>
<a id='n127' href='#n127'>127</a>
<a id='n128' href='#n128'>128</a>
<a id='n129' href='#n129'>129</a>
<a id='n130' href='#n130'>130</a>
<a id='n131' href='#n131'>131</a>
<a id='n132' href='#n132'>132</a>
<a id='n133' href='#n133'>133</a>
<a id='n134' href='#n134'>134</a>
<a id='n135' href='#n135'>135</a>
<a id='n136' href='#n136'>136</a>
<a id='n137' href='#n137'>137</a>
<a id='n138' href='#n138'>138</a>
<a id='n139' href='#n139'>139</a>
<a id='n140' href='#n140'>140</a>
<a id='n141' href='#n141'>141</a>
<a id='n142' href='#n142'>142</a>
<a id='n143' href='#n143'>143</a>
<a id='n144' href='#n144'>144</a>
<a id='n145' href='#n145'>145</a>
<a id='n146' href='#n146'>146</a>
<a id='n147' href='#n147'>147</a>
<a id='n148' href='#n148'>148</a>
<a id='n149' href='#n149'>149</a>
<a id='n150' href='#n150'>150</a>
<a id='n151' href='#n151'>151</a>
<a id='n152' href='#n152'>152</a>
<a id='n153' href='#n153'>153</a>
<a id='n154' href='#n154'>154</a>
<a id='n155' href='#n155'>155</a>
<a id='n156' href='#n156'>156</a>
<a id='n157' href='#n157'>157</a>
<a id='n158' href='#n158'>158</a>
<a id='n159' href='#n159'>159</a>
<a id='n160' href='#n160'>160</a>
<a id='n161' href='#n161'>161</a>
<a id='n162' href='#n162'>162</a>
<a id='n163' href='#n163'>163</a>
<a id='n164' href='#n164'>164</a>
<a id='n165' href='#n165'>165</a>
<a id='n166' href='#n166'>166</a>
<a id='n167' href='#n167'>167</a>
<a id='n168' href='#n168'>168</a>
<a id='n169' href='#n169'>169</a>
<a id='n170' href='#n170'>170</a>
<a id='n171' href='#n171'>171</a>
<a id='n172' href='#n172'>172</a>
<a id='n173' href='#n173'>173</a>
<a id='n174' href='#n174'>174</a>
<a id='n175' href='#n175'>175</a>
<a id='n176' href='#n176'>176</a>
<a id='n177' href='#n177'>177</a>
<a id='n178' href='#n178'>178</a>
<a id='n179' href='#n179'>179</a>
<a id='n180' href='#n180'>180</a>
<a id='n181' href='#n181'>181</a>
<a id='n182' href='#n182'>182</a>
<a id='n183' href='#n183'>183</a>
<a id='n184' href='#n184'>184</a>
<a id='n185' href='#n185'>185</a>
<a id='n186' href='#n186'>186</a>
<a id='n187' href='#n187'>187</a>
<a id='n188' href='#n188'>188</a>
<a id='n189' href='#n189'>189</a>
<a id='n190' href='#n190'>190</a>
<a id='n191' href='#n191'>191</a>
<a id='n192' href='#n192'>192</a>
<a id='n193' href='#n193'>193</a>
<a id='n194' href='#n194'>194</a>
<a id='n195' href='#n195'>195</a>
<a id='n196' href='#n196'>196</a>
<a id='n197' href='#n197'>197</a>
<a id='n198' href='#n198'>198</a>
<a id='n199' href='#n199'>199</a>
<a id='n200' href='#n200'>200</a>
<a id='n201' href='#n201'>201</a>
<a id='n202' href='#n202'>202</a>
<a id='n203' href='#n203'>203</a>
<a id='n204' href='#n204'>204</a>
<a id='n205' href='#n205'>205</a>
<a id='n206' href='#n206'>206</a>
<a id='n207' href='#n207'>207</a>
<a id='n208' href='#n208'>208</a>
<a id='n209' href='#n209'>209</a>
<a id='n210' href='#n210'>210</a>
<a id='n211' href='#n211'>211</a>
<a id='n212' href='#n212'>212</a>
<a id='n213' href='#n213'>213</a>
<a id='n214' href='#n214'>214</a>
<a id='n215' href='#n215'>215</a>
<a id='n216' href='#n216'>216</a>
<a id='n217' href='#n217'>217</a>
<a id='n218' href='#n218'>218</a>
<a id='n219' href='#n219'>219</a>
<a id='n220' href='#n220'>220</a>
<a id='n221' href='#n221'>221</a>
<a id='n222' href='#n222'>222</a>
<a id='n223' href='#n223'>223</a>
<a id='n224' href='#n224'>224</a>
<a id='n225' href='#n225'>225</a>
<a id='n226' href='#n226'>226</a>
<a id='n227' href='#n227'>227</a>
<a id='n228' href='#n228'>228</a>
<a id='n229' href='#n229'>229</a>
<a id='n230' href='#n230'>230</a>
<a id='n231' href='#n231'>231</a>
<a id='n232' href='#n232'>232</a>
<a id='n233' href='#n233'>233</a>
<a id='n234' href='#n234'>234</a>
<a id='n235' href='#n235'>235</a>
<a id='n236' href='#n236'>236</a>
<a id='n237' href='#n237'>237</a>
<a id='n238' href='#n238'>238</a>
<a id='n239' href='#n239'>239</a>
<a id='n240' href='#n240'>240</a>
<a id='n241' href='#n241'>241</a>
<a id='n242' href='#n242'>242</a>
<a id='n243' href='#n243'>243</a>
<a id='n244' href='#n244'>244</a>
<a id='n245' href='#n245'>245</a>
<a id='n246' href='#n246'>246</a>
<a id='n247' href='#n247'>247</a>
<a id='n248' href='#n248'>248</a>
<a id='n249' href='#n249'>249</a>
<a id='n250' href='#n250'>250</a>
<a id='n251' href='#n251'>251</a>
<a id='n252' href='#n252'>252</a>
<a id='n253' href='#n253'>253</a>
<a id='n254' href='#n254'>254</a>
<a id='n255' href='#n255'>255</a>
<a id='n256' href='#n256'>256</a>
<a id='n257' href='#n257'>257</a>
<a id='n258' href='#n258'>258</a>
<a id='n259' href='#n259'>259</a>
<a id='n260' href='#n260'>260</a>
<a id='n261' href='#n261'>261</a>
</pre></td>
<td class='lines'><pre><code><style>
@media only all and (prefers-color-scheme: dark) {
.highlight .hll { background-color: #49483e }
.highlight .c { color: #75715e } /* Comment */
.highlight .err { color: #960050; background-color: #1e0010 } /* Error */
.highlight .k { color: #66d9ef } /* Keyword */
.highlight .l { color: #ae81ff } /* Literal */
.highlight .n { color: #f8f8f2 } /* Name */
.highlight .o { color: #f92672 } /* Operator */
.highlight .p { color: #f8f8f2 } /* Punctuation */
.highlight .ch { color: #75715e } /* Comment.Hashbang */
.highlight .cm { color: #75715e } /* Comment.Multiline */
.highlight .cp { color: #75715e } /* Comment.Preproc */
.highlight .cpf { color: #75715e } /* Comment.PreprocFile */
.highlight .c1 { color: #75715e } /* Comment.Single */
.highlight .cs { color: #75715e } /* Comment.Special */
.highlight .gd { color: #f92672 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gi { color: #a6e22e } /* Generic.Inserted */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #75715e } /* Generic.Subheading */
.highlight .kc { color: #66d9ef } /* Keyword.Constant */
.highlight .kd { color: #66d9ef } /* Keyword.Declaration */
.highlight .kn { color: #f92672 } /* Keyword.Namespace */
.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */
.highlight .kr { color: #66d9ef } /* Keyword.Reserved */
.highlight .kt { color: #66d9ef } /* Keyword.Type */
.highlight .ld { color: #e6db74 } /* Literal.Date */
.highlight .m { color: #ae81ff } /* Literal.Number */
.highlight .s { color: #e6db74 } /* Literal.String */
.highlight .na { color: #a6e22e } /* Name.Attribute */
.highlight .nb { color: #f8f8f2 } /* Name.Builtin */
.highlight .nc { color: #a6e22e } /* Name.Class */
.highlight .no { color: #66d9ef } /* Name.Constant */
.highlight .nd { color: #a6e22e } /* Name.Decorator */
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
.highlight .ne { color: #a6e22e } /* Name.Exception */
.highlight .nf { color: #a6e22e } /* Name.Function */
.highlight .nl { color: #f8f8f2 } /* Name.Label */
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
.highlight .nx { color: #a6e22e } /* Name.Other */
.highlight .py { color: #f8f8f2 } /* Name.Property */
.highlight .nt { color: #f92672 } /* Name.Tag */
.highlight .nv { color: #f8f8f2 } /* Name.Variable */
.highlight .ow { color: #f92672 } /* Operator.Word */
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
.highlight .mb { color: #ae81ff } /* Literal.Number.Bin */
.highlight .mf { color: #ae81ff } /* Literal.Number.Float */
.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */
.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */
.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */
.highlight .sa { color: #e6db74 } /* Literal.String.Affix */
.highlight .sb { color: #e6db74 } /* Literal.String.Backtick */
.highlight .sc { color: #e6db74 } /* Literal.String.Char */
.highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */
.highlight .sd { color: #e6db74 } /* Literal.String.Doc */
.highlight .s2 { color: #e6db74 } /* Literal.String.Double */
.highlight .se { color: #ae81ff } /* Literal.String.Escape */
.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */
.highlight .si { color: #e6db74 } /* Literal.String.Interpol */
.highlight .sx { color: #e6db74 } /* Literal.String.Other */
.highlight .sr { color: #e6db74 } /* Literal.String.Regex */
.highlight .s1 { color: #e6db74 } /* Literal.String.Single */
.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */
.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #a6e22e } /* Name.Function.Magic */
.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */
.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */
.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */
.highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */
.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */
}
@media (prefers-color-scheme: light) {
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
}
</style><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
<span class="c1"># SPDX-license-identifier: Apache-2.0</span>
<span class="c1">##############################################################################</span>
<span class="c1"># Copyright (c) 2016 NEC and others.</span>
<span class="c1"># All rights reserved. This program and the accompanying materials</span>
<span class="c1"># are made available under the terms of the Apache License, Version 2.0</span>
<span class="c1"># which accompanies this distribution, and is available at</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">##############################################################################</span>

<span class="nb">set</span> +e

<span class="nv">DOCS_DIR</span><span class="o">=</span><span class="si">${</span><span class="nv">DOCS_DIR</span><span class="k">:-</span><span class="nv">docs</span><span class="si">}</span>
<span class="nv">INDEX_RST</span><span class="o">=</span><span class="si">${</span><span class="nv">INDEX_RST</span><span class="k">:-</span><span class="nv">index</span><span class="p">.rst</span><span class="si">}</span>
<span class="nv">BUILD_DIR</span><span class="o">=</span><span class="si">${</span><span class="nv">BUILD_DIR</span><span class="k">:-</span><span class="nv">docs_build</span><span class="si">}</span>
<span class="nv">OUTPUT_DIR</span><span class="o">=</span><span class="si">${</span><span class="nv">OUTPUT_DIR</span><span class="k">:-</span><span class="nv">docs_output</span><span class="si">}</span>
<span class="nv">SRC_DIR</span><span class="o">=</span><span class="si">${</span><span class="nv">SRC_DIR</span><span class="k">:-</span><span class="nv">$BUILD_DIR</span><span class="p">/_src</span><span class="si">}</span>
<span class="nv">VENV_DIR</span><span class="o">=</span><span class="si">${</span><span class="nv">VENV_DIR</span><span class="k">:-</span><span class="nv">$BUILD_DIR</span><span class="p">/_venv</span><span class="si">}</span>
<span class="nv">OPNFVDOCS_DIR</span><span class="o">=</span><span class="si">${</span><span class="nv">OPNFVDOCS_DIR</span><span class="k">:-</span><span class="nv">$BUILD_DIR</span><span class="p">/_opnfvdocs</span><span class="si">}</span>
<span class="nv">GERRIT_COMMENT</span><span class="o">=</span><span class="si">${</span><span class="nv">GERRIT_COMMENT</span><span class="k">:-</span><span class="si">}</span>

<span class="nv">revision</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>git rev-parse --short HEAD<span class="k">)</span><span class="s2">&quot;</span>
<span class="nv">rev_full</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>git rev-parse HEAD<span class="k">)</span><span class="s2">&quot;</span>
<span class="nv">version</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>git tag <span class="p">|</span> tail -1<span class="k">)</span><span class="s2">&quot;</span>
<span class="nv">project</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>basename <span class="k">$(</span>git rev-parse --show-toplevel<span class="k">))</span><span class="s2">&quot;</span>
<span class="nv">html_notes</span><span class="o">=</span><span class="s2">&quot;    Revision: </span><span class="nv">$rev_full</span><span class="s2">\n    Build date: </span><span class="k">$(</span>date -u +<span class="s1">&#39;%Y-%m-%d&#39;</span><span class="k">)</span><span class="s2">&quot;</span>
<span class="nv">opnfv_logo</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$OPNFVDOCS_DIR</span><span class="s2">/etc/opnfv-logo.png&quot;</span>
<span class="nv">copyright</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>date +%Y<span class="k">)</span><span class="s2">, OPNFV.&quot;</span>
<span class="nv">copyrightlong</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>date +%Y<span class="k">)</span><span class="s2">, OPNFV. Licensed under CC BY 4.0.&quot;</span>
<span class="nv">error_count</span><span class="o">=</span><span class="m">0</span>

<span class="k">function</span> set_error<span class="o">()</span> <span class="o">{</span>
    <span class="c1"># TODO(yujunz) log detail errors</span>
    <span class="nv">error_count</span><span class="o">=</span><span class="k">$((</span>error_count <span class="o">+</span> <span class="m">1</span><span class="k">))</span>
<span class="o">}</span>

<span class="k">if</span> <span class="o">[</span> <span class="s2">&quot;</span><span class="k">$(</span>uname<span class="k">)</span><span class="s2">&quot;</span> <span class="o">==</span> <span class="s2">&quot;Darwin&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
  <span class="c1"># Override system $SED/$FIND with gnu $SED and gnu $FIND</span>
  <span class="c1"># If not found, install with</span>
  <span class="c1"># $ brew install gnu-sed findutils</span>
  <span class="nb">echo</span> <span class="s2">&quot;macOS detected.&quot;</span>
  <span class="nv">SED</span><span class="o">=</span><span class="s2">&quot;gsed&quot;</span>
  <span class="nv">FIND</span><span class="o">=</span><span class="s2">&quot;gfind&quot;</span>
<span class="k">else</span>
  <span class="nv">SED</span><span class="o">=</span><span class="s2">&quot;sed&quot;</span>
  <span class="nv">FIND</span><span class="o">=</span><span class="s2">&quot;find&quot;</span>
<span class="k">fi</span>

<span class="k">function</span> check_rst_doc<span class="o">()</span> <span class="o">{</span>
    <span class="nv">_src</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span>

    <span class="c1"># Note: This check may fail in many jobs for building project docs, since</span>
    <span class="c1">#       the old sample has lines more than 120. We ignore failures on this</span>
    <span class="c1">#       check right now, but these have to be fixed before OPNFV B release.</span>
    <span class="nv">_out</span><span class="o">=</span><span class="k">$(</span>doc8 --max-line-length <span class="m">240</span> --ignore D000 <span class="s2">&quot;</span><span class="nv">$_src</span><span class="s2">&quot;</span><span class="k">)</span> <span class="o">||</span> <span class="o">{</span>
        <span class="nv">_msg</span><span class="o">=</span><span class="s1">&#39;Warning: rst validation (doc8) has failed, please fix the following error(s).&#39;</span>
        <span class="nv">_errs</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span> <span class="s2">&quot;</span><span class="nv">$_out</span><span class="s2">&quot;</span> <span class="p">|</span> <span class="nv">$SED</span> -n -e <span class="s2">&quot;/^</span><span class="nv">$_src</span><span class="s2">/s/^/    /p&quot;</span><span class="k">)</span>
        <span class="nb">echo</span>
        <span class="nb">echo</span> -e <span class="s2">&quot;</span><span class="nv">$_msg</span><span class="s2">\n</span><span class="nv">$_errs</span><span class="s2">&quot;</span>
        <span class="nb">echo</span>
        <span class="k">if</span> <span class="o">[</span> -n <span class="s2">&quot;</span><span class="nv">$GERRIT_COMMENT</span><span class="s2">&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
            <span class="nb">echo</span> -e <span class="s2">&quot;</span><span class="nv">$_msg</span><span class="s2">\n</span><span class="nv">$_errs</span><span class="s2">&quot;</span> &gt;&gt; <span class="s2">&quot;</span><span class="nv">$GERRIT_COMMENT</span><span class="s2">&quot;</span>
        <span class="k">fi</span>
    <span class="o">}</span>
<span class="o">}</span>

<span class="k">function</span> add_html_notes<span class="o">()</span> <span class="o">{</span>
    <span class="nv">_src</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span>

    <span class="nv">$FIND</span> <span class="s2">&quot;</span><span class="nv">$_src</span><span class="s2">&quot;</span> -name <span class="s1">&#39;*.rst&#39;</span> <span class="p">|</span> <span class="k">while</span> <span class="nb">read</span> file
    <span class="k">do</span>
        <span class="k">if</span> grep -q -e <span class="s1">&#39; _sha1_&#39;</span> <span class="s2">&quot;</span><span class="nv">$file</span><span class="s2">&quot;</span> <span class="p">;</span> <span class="k">then</span>
            <span class="c1"># TODO: remove this, once old templates were removed from all repos.</span>
            <span class="nb">echo</span>
            <span class="nb">echo</span> <span class="s2">&quot;Warn: &#39;_sha1_&#39; was found in [</span><span class="nv">$file</span><span class="s2">], use the latest document template.&quot;</span>
            <span class="nb">echo</span> <span class="s2">&quot;      See http://artifacts.opnfv.org/opnfvdocs/docs/how-to-use-docs .&quot;</span>
            <span class="nb">echo</span>
            <span class="nv">$SED</span> -i <span class="s2">&quot;s/ _sha1_/ </span><span class="nv">$git_sha1</span><span class="s2">/g&quot;</span> <span class="s2">&quot;</span><span class="nv">$file</span><span class="s2">&quot;</span>
        <span class="k">fi</span>
        <span class="nv">$SED</span> -i -e <span class="s2">&quot;\$a\\\n..\n</span><span class="nv">$html_notes</span><span class="s2">&quot;</span> <span class="s2">&quot;</span><span class="nv">$file</span><span class="s2">&quot;</span>
    <span class="k">done</span>
<span class="o">}</span>

<span class="k">function</span> prepare_src_files<span class="o">()</span> <span class="o">{</span>
    mkdir -p <span class="s2">&quot;</span><span class="k">$(</span>dirname <span class="nv">$SRC_DIR</span><span class="k">)</span><span class="s2">&quot;</span>

    <span class="k">if</span> <span class="o">[</span> -e <span class="s2">&quot;</span><span class="nv">$SRC_DIR</span><span class="s2">&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
        rm -rf <span class="s2">&quot;</span><span class="nv">$SRC_DIR</span><span class="s2">&quot;</span>
    <span class="k">fi</span>
    cp -r <span class="s2">&quot;</span><span class="nv">$DOCS_DIR</span><span class="s2">&quot;</span> <span class="s2">&quot;</span><span class="nv">$SRC_DIR</span><span class="s2">&quot;</span>
    add_html_notes <span class="s2">&quot;</span><span class="nv">$SRC_DIR</span><span class="s2">&quot;</span>
<span class="o">}</span>

<span class="k">function</span> add_config<span class="o">()</span> <span class="o">{</span>
    <span class="nv">_conf</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span>
    <span class="nv">_param</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$2</span><span class="s2">&quot;</span>
    <span class="nv">_val</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$3</span><span class="s2">&quot;</span>

    <span class="k">if</span> ! grep -q -e <span class="s2">&quot;^</span><span class="nv">$_param</span><span class="s2"> = &quot;</span> <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="p">;</span> <span class="k">then</span>
        <span class="nb">echo</span> <span class="s2">&quot;Adding &#39;</span><span class="nv">$_param</span><span class="s2">&#39; into </span><span class="nv">$_conf</span><span class="s2"> ...&quot;</span>
        <span class="nb">echo</span> <span class="s2">&quot;</span><span class="nv">$_param</span><span class="s2"> = </span><span class="nv">$_val</span><span class="s2">&quot;</span> &gt;&gt; <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span>
    <span class="k">fi</span>
<span class="o">}</span>

<span class="c1"># Note: User can customize config for specific document by creating &#39;conf.py&#39;</span>
<span class="c1">#       in the taeget document dir (e.g. docs/abc/conf.py). This config file does</span>
<span class="c1">#       not need to cover all config parameter, as all missing parameter will be</span>
<span class="c1">#       automatically filled by this function.</span>
<span class="k">function</span> prepare_config<span class="o">()</span> <span class="o">{</span>
    <span class="nv">_src</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span>
    <span class="nv">_name</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$2</span><span class="s2">&quot;</span>
    <span class="nv">_conf</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$_src</span><span class="s2">/conf.py&quot;</span>

    touch <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span>

    <span class="c1"># default params</span>
    <span class="c1"># Note: If you want to add a new sphinx extention here, you may need python</span>
    <span class="c1">#       package for it (e.g. python package &#39;sphinxcontrib-httpdomain&#39; is</span>
    <span class="c1">#       required by &#39;sphinxcontrib.httpdomain&#39;). If you need such python</span>
    <span class="c1">#       package, add the name of the python package into the requirement</span>
    <span class="c1">#       list &#39;docs/etc/requirements.txt&#39; .</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;extensions&#39;</span> <span class="se">\</span>
    <span class="s2">&quot;[&#39;sphinxcontrib.httpdomain&#39;, &#39;sphinx.ext.autodoc&#39;, &#39;sphinx.ext.viewcode&#39;, &#39;sphinx.ext.napoleon&#39;]&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;needs_sphinx&#39;</span> <span class="s2">&quot;&#39;1.3&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;numfig&#39;</span> <span class="s2">&quot;True&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;master_doc&#39;</span> <span class="s2">&quot;&#39;index&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;pygments_style&#39;</span> <span class="s2">&quot;&#39;sphinx&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;html_use_index&#39;</span> <span class="s2">&quot;False&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;html_last_updated_fmt&#39;</span> <span class="s2">&quot;&#39;%b %d, %Y&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;html_logo&#39;</span> <span class="s2">&quot;&#39;opnfv-logo.png&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;html_sidebars&#39;</span> <span class="se">\</span>
                        <span class="s2">&quot;{&#39;**&#39;: [&#39;globaltoc.html&#39;,</span>
<span class="s2">                                 &#39;</span><span class="k">$(</span><span class="nb">cd</span> <span class="nv">$OPNFVDOCS_DIR</span><span class="p">;</span> <span class="nb">pwd</span><span class="k">)</span><span class="s2">/etc/pagemenu.html&#39;,</span>
<span class="s2">                                 &#39;searchbox.html&#39;]}&quot;</span>

    <span class="c1"># genarated params</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;release&#39;</span> <span class="s2">&quot;u&#39;</span><span class="nv">$version</span><span class="s2">&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;version&#39;</span> <span class="s2">&quot;u&#39;</span><span class="nv">$version</span><span class="s2">&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;project&#39;</span> <span class="s2">&quot;u&#39;</span><span class="nv">$project</span><span class="s2">&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;copyright&#39;</span> <span class="s2">&quot;u&#39;</span><span class="nv">$copyrightlong</span><span class="s2">&#39;&quot;</span>
    add_config <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span> <span class="s1">&#39;rst_epilog&#39;</span> <span class="s2">&quot;u&#39;</span><span class="nv">$html_notes</span><span class="s2">&#39;&quot;</span>

    <span class="nb">echo</span> <span class="s2">&quot;sphinx config to be used:&quot;</span>
    <span class="nb">echo</span>
    <span class="nv">$SED</span> -e <span class="s2">&quot;s/^/    /&quot;</span> <span class="s2">&quot;</span><span class="nv">$_conf</span><span class="s2">&quot;</span>
    <span class="nb">echo</span>
<span class="o">}</span>

<span class="k">function</span> is_top_dir<span class="o">()</span> <span class="o">{</span>
    <span class="o">[[</span> <span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span> <span class="o">==</span> <span class="s2">&quot;</span><span class="nv">$DOCS_DIR</span><span class="s2">&quot;</span> <span class="o">]]</span>
<span class="o">}</span>

<span class="k">function</span> generate_name_for_top_dir<span class="o">()</span> <span class="o">{</span>
    <span class="k">for</span> suffix in <span class="s1">&#39;&#39;</span> <span class="s1">&#39;.top&#39;</span> <span class="s1">&#39;.all&#39;</span> <span class="s1">&#39;.master&#39;</span> <span class="s1">&#39;_&#39;</span> <span class="s1">&#39;__&#39;</span> <span class="s1">&#39;___&#39;</span>
    <span class="k">do</span>
        <span class="nv">_name</span><span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span>basename <span class="nv">$DOCS_DIR</span><span class="k">)</span><span class="nv">$suffix</span><span class="s2">&quot;</span>
        <span class="o">[[</span> -e <span class="s2">&quot;</span><span class="nv">$DOCS_DIR</span><span class="s2">/</span><span class="nv">$_name</span><span class="s2">&quot;</span> <span class="o">]]</span> <span class="o">&amp;&amp;</span> <span class="k">continue</span>
        <span class="nb">echo</span> <span class="s2">&quot;</span><span class="nv">$_name</span><span class="s2">&quot;</span>
        <span class="k">return</span>
    <span class="k">done</span>

    <span class="nb">echo</span> <span class="s2">&quot;Error: cannot find name for top directory [</span><span class="nv">$DOCS_DIR</span><span class="s2">]&quot;</span>
    set_error
<span class="o">}</span>

<span class="k">function</span> generate_name<span class="o">()</span> <span class="o">{</span>
    <span class="nv">_dir</span><span class="o">=</span><span class="nv">$1</span>

    <span class="k">if</span> is_top_dir <span class="s2">&quot;</span><span class="nv">$_dir</span><span class="s2">&quot;</span> <span class="p">;</span> <span class="k">then</span>
        <span class="nv">_name</span><span class="o">=</span><span class="k">$(</span>generate_name_for_top_dir <span class="nv">$DOCS_DIR</span><span class="k">)</span>
    <span class="k">else</span>
        <span class="nv">_name</span><span class="o">=</span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">_dir</span><span class="p">#</span><span class="nv">$DOCS_DIR</span><span class="p">/</span><span class="si">}</span><span class="s2">&quot;</span>
    <span class="k">fi</span>
    <span class="c1"># Replace &#39;/&#39; by &#39;_&#39;</span>
    <span class="nb">echo</span> <span class="s2">&quot;</span><span class="si">${</span><span class="nv">_name</span><span class="p">////_</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="o">}</span>


<span class="k">if</span> <span class="o">[[</span> ! -d <span class="s2">&quot;</span><span class="nv">$OPNFVDOCS_DIR</span><span class="s2">&quot;</span> <span class="o">]]</span> <span class="p">;</span> <span class="k">then</span>
    <span class="nb">echo</span> <span class="s2">&quot;Error: </span><span class="nv">$OPNFVDOCS_DIR</span><span class="s2"> dir not found.&quot;</span>
    <span class="nb">echo</span> <span class="s2">&quot;See http://artifacts.opnfv.org/opnfvdocs/docs/how-to-use-docs .&quot;</span>
    set_error
<span class="k">fi</span>

<span class="k">if</span> ! which virtualenv &gt; /dev/null <span class="p">;</span> <span class="k">then</span>
    <span class="nb">echo</span> <span class="s2">&quot;Error: &#39;virtualenv&#39; not found. Exec &#39;sudo pip install virtualenv&#39; first.&quot;</span>
    set_error
<span class="k">fi</span>

<span class="c1"># workaround for doc8 error in python2.6</span>
<span class="k">if</span> <span class="o">[[</span> <span class="k">$(</span>python -V <span class="m">2</span>&gt;<span class="p">&amp;</span><span class="m">1</span><span class="k">)</span> <span class="o">==</span> Python<span class="se">\ </span><span class="m">2</span>.6.* <span class="o">]]</span> <span class="o">&amp;&amp;</span> <span class="o">[</span> -e /usr/bin/python2.7 <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
    <span class="nb">echo</span> <span class="s2">&quot;creating venv with Python 2.7 instead of Python 2.6.x ...&quot;</span>
    virtualenv <span class="s2">&quot;</span><span class="nv">$VENV_DIR</span><span class="s2">&quot;</span> --python<span class="o">=</span>/usr/bin/python2.7
<span class="k">else</span>
    virtualenv <span class="s2">&quot;</span><span class="nv">$VENV_DIR</span><span class="s2">&quot;</span>
<span class="k">fi</span>

<span class="nb">source</span> <span class="s2">&quot;</span><span class="nv">$VENV_DIR</span><span class="s2">/bin/activate&quot;</span>
pip install -r <span class="s2">&quot;</span><span class="nv">$OPNFVDOCS_DIR</span><span class="s2">/etc/requirements.txt&quot;</span>

check_rst_doc <span class="nv">$DOCS_DIR</span>

prepare_src_files

<span class="k">if</span> <span class="o">[</span> -e <span class="s2">&quot;</span><span class="nv">$DOCS_DIR</span><span class="s2">/pre-hook.sh&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
    <span class="nb">source</span> <span class="s2">&quot;</span><span class="nv">$DOCS_DIR</span><span class="s2">/pre-hook.sh&quot;</span>
<span class="k">fi</span>

<span class="nv">$FIND</span> <span class="nv">$DOCS_DIR</span> -name <span class="nv">$INDEX_RST</span> -printf <span class="s1">&#39;%h\n&#39;</span> <span class="p">|</span> <span class="k">while</span> <span class="nb">read</span> dir
<span class="k">do</span>
    <span class="nv">name</span><span class="o">=</span><span class="k">$(</span>generate_name <span class="nv">$dir</span><span class="k">)</span>
    <span class="k">if</span> is_top_dir <span class="s2">&quot;</span><span class="nv">$dir</span><span class="s2">&quot;</span> <span class="p">;</span> <span class="k">then</span>
        <span class="nv">src</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$SRC_DIR</span><span class="s2">&quot;</span>
    <span class="k">else</span>
        <span class="nv">src</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$SRC_DIR</span><span class="s2">/</span><span class="si">${</span><span class="nv">dir</span><span class="p">#</span><span class="nv">$DOCS_DIR</span><span class="p">/</span><span class="si">}</span><span class="s2">&quot;</span>
    <span class="k">fi</span>
    <span class="nv">build</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$BUILD_DIR</span><span class="s2">/</span><span class="nv">$name</span><span class="s2">&quot;</span>
    <span class="nv">output</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$OUTPUT_DIR</span><span class="s2">/</span><span class="nv">$name</span><span class="s2">&quot;</span>

    <span class="nb">echo</span>
    <span class="nb">echo</span> <span class="s2">&quot;#################</span><span class="si">${</span><span class="nv">dir</span><span class="p">//?/#</span><span class="si">}</span><span class="s2">&quot;</span>
    <span class="nb">echo</span> <span class="s2">&quot;Building DOCS in </span><span class="nv">$dir</span><span class="s2">&quot;</span>
    <span class="nb">echo</span> <span class="s2">&quot;#################</span><span class="si">${</span><span class="nv">dir</span><span class="p">//?/#</span><span class="si">}</span><span class="s2">&quot;</span>
    <span class="nb">echo</span>

    prepare_config <span class="s2">&quot;</span><span class="nv">$src</span><span class="s2">&quot;</span> <span class="s2">&quot;</span><span class="nv">$name</span><span class="s2">&quot;</span>
    cp -f <span class="nv">$opnfv_logo</span> <span class="s2">&quot;</span><span class="nv">$src</span><span class="s2">/opnfv-logo.png&quot;</span>

    mkdir -p <span class="s2">&quot;</span><span class="nv">$output</span><span class="s2">&quot;</span>

    <span class="o">{</span>
        sphinx-build -b singlehtml -t singlehtml -E <span class="s2">&quot;</span><span class="nv">$src</span><span class="s2">&quot;</span> <span class="s2">&quot;</span><span class="nv">$output</span><span class="s2">&quot;</span>
    <span class="o">}</span> <span class="o">||</span> <span class="o">{</span>
        <span class="nv">msg</span><span class="o">=</span><span class="s2">&quot;Error: HTML creation for </span><span class="nv">$dir</span><span class="s2"> has failed.&quot;</span>
        <span class="nb">echo</span>
        <span class="nb">echo</span> <span class="s2">&quot;</span><span class="nv">$msg</span><span class="s2">&quot;</span>
        <span class="nb">echo</span>
        <span class="k">if</span> <span class="o">[</span> -n <span class="s2">&quot;</span><span class="nv">$GERRIT_COMMENT</span><span class="s2">&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
            <span class="nb">echo</span> <span class="s2">&quot;</span><span class="nv">$msg</span><span class="s2">&quot;</span> &gt;&gt; <span class="s2">&quot;</span><span class="nv">$GERRIT_COMMENT</span><span class="s2">&quot;</span>
        <span class="k">fi</span>
    <span class="o">}</span>

    <span class="k">if</span> is_top_dir <span class="s2">&quot;</span><span class="nv">$dir</span><span class="s2">&quot;</span> <span class="p">;</span> <span class="k">then</span>
        <span class="c1"># NOTE: Having top level document (docs/index.rst) is not recommended.</span>
        <span class="c1">#       It may cause conflicts with other docs (mostly with HTML</span>
        <span class="c1">#       folders for contents in top level docs and other document</span>
        <span class="c1">#       folders). But, let&#39;s try merge of those contents into the top</span>
        <span class="c1">#       docs directory.</span>
        <span class="o">(</span>
            <span class="nb">cd</span> <span class="nv">$output</span>
            <span class="nv">$FIND</span> . -type d -print <span class="p">|</span> xargs -I d mkdir -p ../d
            <span class="nv">$FIND</span> . -type f -print <span class="p">|</span> xargs -I f mv -b f ../f
        <span class="o">)</span>
        rm -rf <span class="s2">&quot;</span><span class="nv">$output</span><span class="s2">&quot;</span>
    <span class="k">fi</span>

<span class="k">done</span>

deactivate

<span class="nb">exit</span> <span class="nv">$error_count</span>
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div id="lfcollabprojects-footer">
  <div class="gray-diagonal">
    <div class="footer-inner">
      <p>
        &copy; 2015
        <a href="https://opnfv.org/">Open Platform for NFV Project, Inc</a>., a
        Linux Foundation Collaborative Project. All Rights Reserved.
      </p>
      <p>
        Open Platform for NFV and OPNFV are trademarks of the Open Platform for
        NFV Project, Inc.
      </p>
      <p>
        Linux Foundation is a registered trademark of The Linux Foundation.
        Linux is a registered
        <a
          href="http://www.linuxfoundation.org/programs/legal/trademark"
          title="Linux Mark Institute"
          >trademark</a
        >
        of Linus Torvalds.
      </p>
      <p>
        Please see our
        <a href="https://opnfv.org/about/bylaws-and-policies/terms-use"
          >terms of use</a
        >,
        <a href="https://opnfv.org/about/bylaws-and-policies/trademarks"
          >trademark policy</a
        >, and
        <a href="https://opnfv.org/about/bylaws-and-policies/privacy-policy"
          >privacy policy</a
        >.
      </p>
    </div>
  </div>
</div>
</div> <!-- id=cgit -->
</body>
</html>
