From 92a15091e721167a42085340eed205ddf4ce155b Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Fri, 18 Mar 2016 07:13:40 -0400 Subject: [PATCH] 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 --- doc/source/index.rst | 4 ---- setup.cfg | 8 -------- 2 files changed, 12 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 4e630a5ee4d0..22ed0d0aa8c7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -222,11 +222,7 @@ Module Reference .. toctree:: :hidden: - api/autoindex - Indices and tables ================== -* :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/setup.cfg b/setup.cfg index ecc2948db977..120d41b9a8e2 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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