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

Bug #1266623 reported by Mike Spreitzer
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Undecided
Mike Spreitzer

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.

Revision history for this message
Mike Spreitzer (mike-spreitzer) wrote :

Preparing patch.

Changed in nova:
assignee: nobody → Mike Spreitzer (mike-spreitzer)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/65229

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/65229
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=27c8713840d905185e22e8af44cea340921f1cb2
Submitter: Jenkins
Branch: master

commit 27c8713840d905185e22e8af44cea340921f1cb2
Author: Mike Spreitzer <email address hidden>
Date: Tue Jan 7 02:47:28 2014 -0500

    Add explicit discussion of dependencies to README.rst

    Noted that building the documentation has more dependencies
    than merely running Nova.
    Noted that the standard development environment is sufficient.
    Noted that the standard runtime environment plus oslo.sphinx
    is sufficient.

    Change-Id: I37b84a1bdfbc906b005c0a53c2c570c0695937b3
    Closes-Bug: #1266623

Changed in nova:
status: In Progress → Fix Committed
Changed in nova:
milestone: none → icehouse-3
Thierry Carrez (ttx)
Changed in nova:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in nova:
milestone: icehouse-3 → 2014.1
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.