Remove auto generated module api documentation

This disables the generation of the raw module api documentation in
our docs target. It is mostly not useful, as it builds a giant tree of
module documentation that are 98% boiler plate lists of methods with
no real content.

We leave the sphinx.ext.autodoc in the conf, which allows you to
specifically pull in modules for documentation when you want
to. doc/source/services.rst is an example of doing this in tree, which
still works after this change.

Change-Id: I4c10a8e45756cdcf612faca574e2fb3b7ffa2bdb
This commit is contained in:
Sean Dague 2016-03-18 07:13:40 -04:00
parent 2e2c225e83
commit 92a15091e7
2 changed files with 0 additions and 12 deletions

View File

@ -222,11 +222,7 @@ Module Reference
.. toctree::
:hidden:
api/autoindex
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -234,14 +234,6 @@ output_file = nova/locale/nova.pot
universal = 1
[pbr]
# Have pbr generate the module indexes like sphinx autodoc
autodoc_index_modules = True
# Exclude modules that won't build with autodoc (or that we don't want doc'ed);
# this requires updating the exclude_patterns variable in doc/source/conf.py
autodoc_exclude_modules = nova.wsgi.nova-*
nova.tests.*
# Treat sphinx warnings as errors during the docs build; this helps us keep
# the documentation clean.
warnerrors = true