yahoo-eng-team team mailing list archive

[Mike Spreitzer <mike-spreitzer@xxxxxxx>]

Public bug reported:

nova/doc/README.rst describes how to build the nova developer
documentation but omits mention of oslo.sphinx.  The doc build requires
oslo.sphinx, but oslo.sphinx is not included in requirements.txt
(because oslo.sphinx is not needed to run nova).  It suffices to pip
install oslo.sphinx; nova's test-requirements.txt includes oslo.sphinx,
so an environment that also includes those items is good for doc
building.  nova/doc/README.rst should be enhanced with such an
explanation.

This bug was found in nova master pulled on Jan 2, 2014.

** Affects: nova
     Importance: Undecided
         Status: New


** Tags: documentation low-hanging-fruit

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1266623

Title:
  nova/doc/README.rst missing remark about oslo.sphinx

Status in OpenStack Compute (Nova):
  New

Bug description:
  nova/doc/README.rst describes how to build the nova developer
  documentation but omits mention of oslo.sphinx.  The doc build
  requires oslo.sphinx, but oslo.sphinx is not included in
  requirements.txt (because oslo.sphinx is not needed to run nova).  It
  suffices to pip install oslo.sphinx; nova's test-requirements.txt
  includes oslo.sphinx, so an environment that also includes those items
  is good for doc building.  nova/doc/README.rst should be enhanced with
  such an explanation.

  This bug was found in nova master pulled on Jan 2, 2014.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1266623/+subscriptions