← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1471934] Re: tox -e docs doesn't build module index

 

The solution for the sphinx stuff is to configure sphinx using the
conf.py in the doc source dir, like in nova that means updating this
file:

https://github.com/openstack/nova/blob/master/doc/source/conf.py#L85

** Changed in: nova
       Status: Triaged => Won't Fix

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1471934

Title:
  tox -e docs doesn't build module index

Status in OpenStack Compute (Nova):
  Won't Fix

Bug description:
  With this change https://review.openstack.org/#/c/121737/
  autodoc_index_modules was set to 0 in the [pbr] section of setup.cfg
  so that you can no longer get to git/nova/doc/build/html/py-
  modindex.html locally to verify that module docstrings are correct.

  We should enable autodoc_index_modules for the docs tox target again.
  The original point of the previous change was to not list the module
  index in the home page, which is fine.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1471934/+subscriptions


References