OpenStack Compute (nova)

Building the docs according to README.rst fails

Bug #1268424 reported by Ahmed Ali-din
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Low
Mike Spreitzer
OpenStack Compute (nova) 2014.2 "juno"

Bug Description

Following the instructions in /nova/doc/README.rst (OpenStack Nova Documentation README) file to build the docs or the man pages fails:
$python setup.py build_sphinx -b man
-running build_sphinx
-creating /home/ahmed/workspace/nova/doc/build/man
-error: 'source_dir' must be a directory name (got `/home/ahmed/workspace/nova/doc/source`)

$ python setup.py build_sphinx
-running build_sphinx
-error: 'source_dir' must be a directory name (got `/home/ahmed/workspace/nova/doc/source`)

See original description
Ahmed Ali-din (ahmeda)
description: updated
Michael Still (mikal)
Changed in nova:
status: New → Triaged
importance: Undecided → Low
Revision history for this message
Alan Pevec (apevec) wrote :

Workaround is to use sphinx<1.2
see bug 1259511

Revision history for this message
Joe Gordon (jogo) wrote :

When I run the command inside an enviornment with all the dependencies (see the source command below) everything works:

 source .tox/py27/bin/activate

 python setup.py build_sphinx

Perhaps we should update the docs to mention the first step.

Anne Gentle (annegentle)
Changed in nova:
assignee: nobody → Anne Gentle (annegentle)
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/82891

Changed in nova:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Changed in nova:
assignee: Anne Gentle (annegentle) → Mike Spreitzer (mike-spreitzer)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on nova (master)

Change abandoned by Anne Gentle (<email address hidden>) on branch: master
Review: https://review.openstack.org/82891

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

Reviewed: https://review.openstack.org/109385
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=664868130d14d1f49ce7c1342cbccb924e05e336
Submitter: Jenkins
Branch: master

commit 664868130d14d1f49ce7c1342cbccb924e05e336
Author: Mike Spreitzer <email address hidden>
Date: Thu Jul 24 14:46:15 2014 -0400

    Work on document structure and doc building

    This patch clarifies the document structure of
    doc/source/devref/development.environment.rst and adds a section about
    how to build the documentation. This patch also strips out the
    redundant information in doc/README.rst, replacing it with a reference
    to doc/source/devref/development.environment.rst.

    Change-Id: Ia354dcbaea35b812327dac7371ea2fe9aec2b594
    Closes-Bug: 1268424

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

Other bug subscribers

Remote bug watches

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