Open Stack

On 01/06/2014 05:37 PM, Mike Spreitzer wrote:
> Matt Riedemann <mriedem at linux.vnet.ibm.com> wrote on 01/06/2014 03:14:45 PM:
>
>  > Try "sudo pip install oslo.sphinx" and then rebuild.  If you're missing
>  > a package, check to see if it's listed in the nova requirements.txt or
>  > test-requirements.txt files.
>
> That solved the problem.  oslo.sphinx is absent from
> nova/requirements.txt and present in nova/test-requirements.txt.
>   nova/doc/README.rst has instructions for building the Nova docs and
> they do not mention manually installing anything.  I think this means
> there is a bug here somewhere.  Does OpenStack have a general position
> on where requirements for doc-building are listed?

Devstack does not, by policy, install test-requirements.txt.

For reasons relating to the automatic publish of docs, oslo.sphinx is in 
test-requirements.txt. That could probably be done slightly better. 
However oslo.sphinx is not actually needed to run nova (for instance) so 
it seemed logically.

I'd suggest patching the README on instructions to build. Strictly, 
oslo.sphinx is not needed, it's just the thing that provides the pretty 
html template that's consistent with openstack.org theming.

	-Sean

-- 
Sean Dague
Samsung Research America
sean at dague.net / sean.dague at samsung.com
http://dague.net