<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Jun 12, 2015 at 4:48 PM, APlimpton <span dir="ltr"><<a href="mailto:aplimpton@gmail.com" target="_blank">aplimpton@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr">Hi,<div><br></div><div>I wanted to clone a project repo (Swift), make a couple of small changes to the developer docs and then view the HTML to be sure everything is set correctly with text editor etc. I started out following the HowTo and HowTo/FirstTimers instuctions, cloned the repo locally on my laptop, made the changes and am ready to look at the local build. </div><div><br></div><div>However there are no instructions on how to do that. I see a Building Output Locally section on the<a href="https://wiki.openstack.org/wiki/Documentation/HowTo" target="_blank"> How To </a>wiki --- but that is for openstack-manuals. When I tried the instructions, just is case they somehow work, I got a large chunk of errors. (mostly about packages and modules that are not installed)</div></div></blockquote><div><br></div><div>All projects have a tox -e docs command. We've been pretty insistent lately.</div><div><br></div><div>So our instructions at <a href="https://wiki.openstack.org/wiki/Documentation/HowTo#Building_Output_Locally">https://wiki.openstack.org/wiki/Documentation/HowTo#Building_Output_Locally</a> should work. </div><div><br></div><div>On Mac, do all this first:<br></div><div><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">Because Sphinx builds have dependent requirements it is best to work with in a virtual environment. Fortunately the project already has tox set up so that you can create a virtualenv that contains the required dependencies. To use it, do this on a Mac or Ubuntu machine with Python and pip already installed:</p><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">Clone the swift repo.</p><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">Change directories into swift.</p><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">Run this:</p><pre style="padding:9.5px;font-family:Monaco,Menlo,Consolas,'Courier New',monospace;font-size:13px;color:rgb(51,51,51);border-radius:4px;margin-top:0px;margin-bottom:10px;line-height:20px;word-break:break-all;word-wrap:break-word;white-space:pre-wrap;border:1px solid rgba(0,0,0,0.14902);background-color:rgb(245,245,245)">tox -e py27
</pre><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px"><br>When you get a congratulations message, run this:</p><p style="margin:0px 0px 10px;color:rgb(51,51,51);font-family:'Arial Unicode MS',Arial,sans-serif;font-size:14px;line-height:20px">Mac/Ubuntu:</p><pre style="padding:9.5px;font-family:Monaco,Menlo,Consolas,'Courier New',monospace;font-size:13px;color:rgb(51,51,51);border-radius:4px;margin-top:0px;margin-bottom:10px;line-height:20px;word-break:break-all;word-wrap:break-word;white-space:pre-wrap;border:1px solid rgba(0,0,0,0.14902);background-color:rgb(245,245,245)">source .tox/py27/bin/activate</pre></div><div><br></div><div>Then run:</div><div><br></div><div><pre style="font-size:13px;padding:9.5px;font-family:Monaco,Menlo,Consolas,'Courier New',monospace;color:rgb(51,51,51);border-radius:4px;margin-top:0px;margin-bottom:10px;line-height:20px;word-break:break-all;word-wrap:break-word;white-space:pre-wrap;border:1px solid rgba(0,0,0,0.14902);background-color:rgb(245,245,245)">tox -e docs
</pre></div><div>Let us know how it goes! On the wiki, feel free to reverse-order those instructions and make them more generic.</div><div><br></div><div>Thanks,</div><div><br></div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><div></div><div>Switching to the <a href="http://docs.openstack.org/infra/manual/developers.html" target="_blank">Developer's Guide</a> was not helpful as they don't cover the docs part. </div><div><br></div><div><div>One of the devs at work suggested using "python ./setup.py build_sphinx"</div></div><div>That also results in numerous errors. </div><div><br></div><div>The best guess I'm hearing now is that I should get a VM, install the project on it and then do the clone etc al. </div><div><br></div><div>How is this actually supposed to work? </div><div><br></div><div>Thanks,</div><div>Amanda</div><div><br></div><div><br></div><div><br></div></div>
<br>_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div>Anne Gentle</div><div>Rackspace</div><div>Principal Engineer</div><div><a href="http://www.justwriteclick.com" target="_blank">www.justwriteclick.com</a></div></div></div>
</div></div>