Fixes up the API docs and module index

- Automatically generate the API docs
- Makes the index on the modules index page useful

Change-Id: I4eafe2c64a0733f6fb81b20e85cd943355860f9a

.gitignore

@@ -41,6 +41,7 @@ output/*/index.html
 
 # Sphinx
 doc/build
+doc/source/api
 
 # pbr generates these
 AUTHORS

doc/source/api.rst

@@ -1,21 +0,0 @@
-=====
- API
-=====
-
-.. automodule:: oslo_cache.core
-   :members:
-
-.. automodule:: oslo_cache.exception
-   :members:
-
-.. automodule:: oslo_cache.backends.dictionary
-   :members:
-
-.. automodule:: oslo_cache.backends.memcache_pool
-   :members:
-
-.. automodule:: oslo_cache.backends.mongo
-   :members:
-
-.. automodule:: oslo_cache.backends.noop
-   :members:

doc/source/conf.py

@@ -50,6 +50,9 @@ add_module_names = True
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# A list of ignored prefixes for module index sorting.
+modindex_common_prefix = ['oslo_cache.']
+
 # -- Options for HTML output --------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with

doc/source/index.rst

@@ -11,7 +11,7 @@ Contents
    :maxdepth: 2
 
    installation
-   api
+   api/modules
    usage
    contributing
    history

setup.cfg

@@ -30,6 +30,7 @@ oslo.config.opts =
 
 [pbr]
 warnerrors = true
+autodoc_tree_index_modules = True
 
 [build_sphinx]
 source-dir = doc/source