yahoo-eng-team team mailing list archive

[Matt Riedemann <mriedem@xxxxxxxxxx>]

Public bug reported:

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.

** Affects: nova
     Importance: Low
     Assignee: Matt Riedemann (mriedem)
         Status: Triaged


** Tags: documentation

** Changed in: nova
   Importance: Undecided => Low

** Changed in: nova
       Status: New => Triaged

** Changed in: nova
     Assignee: (unassigned) => Matt Riedemann (mriedem)

-- 
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):
  Triaged

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