The neutron-lib devref has a link to py-modindex that gives a 404 error

Bug #1656346 reported by Anne Gentle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Low
Boden R

Bug Description

On this page: http://docs.openstack.org/developer/neutron-lib/devref/index.html there's a link to py-modindex but it doesn't exist.

Tags: doc lib
Anne Gentle (annegentle)
summary: - Devref has a link to py-modindex that gives a 404 error
+ The neutron-lib devref has a link to py-modindex that gives a 404 error
Boden R (boden)
Changed in neutron:
status: New → Confirmed
importance: Undecided → Low
tags: added: lib
Boden R (boden)
Changed in neutron:
assignee: nobody → Boden R (boden)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron-lib (master)

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

Changed in neutron:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron-lib (master)

Reviewed: https://review.openstack.org/426368
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=47f482468bda42039f8b02931028429327cc9385
Submitter: Jenkins
Branch: master

commit 47f482468bda42039f8b02931028429327cc9385
Author: Boden R <email address hidden>
Date: Fri Jan 27 12:24:39 2017 -0700

    Remove devref modindex ref

    Sphinx module index docs won't be generated unless a
    module level docstring is included (ex [1]) with class refs.
    As we don't include such module level refs in neutron-lib,
    nothing is generated and thus no py-modindex.html
    is created. This results in a dead link in our devref (see
    bug report).

    This change removes the modindex ref from our devref's
    index to account for this fact. In the future if we wish to
    add module documentation to support generation of
    modindex we can add the ref back into our index.

    [1] https://github.com/openstack/neutron/blob/
    master/neutron/neutron_plugin_base_v2.py#L19

    Change-Id: I4dbf473a9dc6540ef7cb16febd6703aa21f5a0b1
    Closes-Bug: #1656346

Changed in neutron:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/neutron-lib 1.2.0

This issue was fixed in the openstack/neutron-lib 1.2.0 release.

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.