<div dir="ltr"><div><div style="font-size:13px">Hi all,</div><div style="font-size:13px"><br></div><div style="font-size:13px">when it gets to submitting & reviewing patches for the project documentation, it is very convenient to surf through the docs generated by Sphinx in a special Gate job. The problem is that Sphinx uses in gates a theme which is different from that used on ReadTheDocs. So the docs generated in gates look differently from the docs that we have on ReadTheDocs, while the desired behaviour is to have the same Sphinx theme both on ReadTheDocs and in gates.</div><div style="font-size:13px"><br></div><div style="font-size:13px">There is a <a href="http://read-the-docs.readthedocs.org/en/latest/theme.html" target="_blank">snippet</a> that enables the default ReadTheDocs theme locally (and also potentially in gates):</div><div style="font-size:13px"><pre style="white-space:pre-wrap;font-family:Consolas,'Andale Mono WT','Andale Mono','Lucida Console','Lucida Sans Typewriter','DejaVu Sans Mono','Bitstream Vera Sans Mono','Liberation Mono','Nimbus Mono L',Monaco,'Courier New',Courier,monospace;font-size:12px;margin-top:0px;margin-bottom:0px;padding:12px;line-height:1.5;overflow:auto;color:rgb(64,64,64)"><span style="color:rgb(153,153,136);font-style:italic"># on_rtd is whether we are on <a href="http://readthedocs.org/" target="_blank">readthedocs.org</a></span>
import <span style="color:rgb(85,85,85)">os</span>
<span style="color:rgb(51,51,51)">on_rtd</span> <span style="font-weight:bold">=</span> <span style="color:rgb(51,51,51)">os</span><span style="font-weight:bold">.</span><span style="color:rgb(51,51,51)">environ</span><span style="font-weight:bold">.</span><span style="color:rgb(51,51,51)">get</span>(<span style="color:rgb(221,17,68)">'READTHEDOCS'</span>, <span style="color:rgb(153,153,153)">None</span>) <span style="font-weight:bold">==</span> <span style="color:rgb(221,17,68)">'True'</span>
<span style="font-weight:bold">if</span> <span style="font-weight:bold">not</span> <span style="color:rgb(51,51,51)">on_rtd</span>: <span style="color:rgb(153,153,136);font-style:italic"># only import and set the theme if we're building docs locally</span>
import <span style="color:rgb(85,85,85)">sphinx_rtd_theme</span>
<span style="color:rgb(51,51,51)">html_theme</span> <span style="font-weight:bold">=</span> <span style="color:rgb(221,17,68)">'sphinx_rtd_theme'</span>
<span style="color:rgb(51,51,51)">html_theme_path</span> <span style="font-weight:bold">=</span> [<span style="color:rgb(51,51,51)">sphinx_rtd_theme</span><span style="font-weight:bold">.</span><span style="color:rgb(51,51,51)">get_html_theme_path</span>()]
<span style="color:rgb(153,153,136);font-style:italic"># otherwise, <a href="http://readthedocs.org/" target="_blank">readthedocs.org</a> uses their theme by default, so no need to specify it</span></pre></div><div style="font-size:13px">The problem is that it uses the <a href="https://pypi.python.org/pypi/sphinx_rtd_theme" target="_blank">sphinx_rtd_theme</a> python package, which is not included in the global requirements. What should be done then to enable that default ReadTheDocs theme in gates?</div></div><div><br></div><br clear="all"><div><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><font color="#666666">Best regards,</font><div><font color="#666666">Mikhail Dubov</font></div><div><font color="#666666"><br></font></div><div><span style="color:rgb(102,102,102);font-family:arial;font-size:small">Engineering OPS</span><br></div><div><font color="#666666">Mirantis, Inc.</font></div><div><font color="#666666">E-Mail: <a href="mailto:mdubov@mirantis.com" target="_blank">mdubov@mirantis.com</a></font></div><div><font color="#666666">Skype: msdubov</font></div></div></div></div></div></div>
</div>