yahoo-eng-team team mailing list archive
-
yahoo-eng-team team
-
Mailing list archive
-
Message #61159
[Bug 1656346] Re: The neutron-lib devref has a link to py-modindex that gives a 404 error
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 <bodenvmw@xxxxxxxxx>
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
--
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1656346
Title:
The neutron-lib devref has a link to py-modindex that gives a 404
error
Status in neutron:
Fix Released
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.
To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1656346/+subscriptions
References