PBR

sphinx warns about autoindex file

Bug #1307769 reported by Ruby Loo
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
PBR
Fix Released
Undecided
Ruby Loo

Bug Description

sphinx (v1.1.3) emits warnings about the autoindex file that pbr (0.8.0) generates:

/home/rloo/python-ironicclient/doc/source/api/autoindex.rst:1: WARNING: toctree contains reference to nonexisting document u'api/ :maxdepth: 1'
/home/rloo/python-ironicclient/doc/source/api/autoindex.rst:1: WARNING: toctree contains reference to nonexisting document u'api/ ironicclient.client'

The lines following the toctree directive should be indented relative to the directive start. Instead, the first few lines of the autoindex file look like:

.. toctree::
    :maxdepth: 1

       ironicclient.client.rst
   ironicclient.common.base.rst
   ironicclient.common.http.rst

The lines following the toctree directive should be indented relative to the directive start.

Ruby Loo (rloo)
Changed in pbr:
assignee: nobody → Ruby Loo (rloo)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to pbr (master)

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

Changed in pbr:
status: New → In Progress
Revision history for this message
Openstack Gerrit (openstack-gerrit) wrote : Fix merged to pbr (master)

Reviewed: https://review.openstack.org/87428
Committed: https://git.openstack.org/cgit/openstack-dev/pbr/commit/?id=e67ff52d845f99121402c6b9185265c989eccfa9
Submitter: Jenkins
Branch: master

commit e67ff52d845f99121402c6b9185265c989eccfa9
Author: Ruby Loo <email address hidden>
Date: Tue Apr 15 02:06:51 2014 +0000

    Format autoindex.rst file properly

    Fix the indentation of the lines following the "toctree" directive
    in the autoindex.rst file, so that they are aligned under the
    start of the "toctree" directive.

    Change-Id: Iff4ec8ea05819f6126a7be3d1fb5238c969fca21
    Closes-Bug: #1307769

Changed in pbr:
status: In Progress → Fix Committed
Changed in pbr:
status: Fix Committed → Fix Released
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.