add auto-generated api documentation

Change-Id: I1e2f89a1bacdaa22a82b058f7a44966ec42b935b

.gitignore

@@ -46,6 +46,7 @@ doc/build
 # pbr generates these
 AUTHORS
 ChangeLog
+/doc/source/api/
 
 # Editors
 *~

doc/source/api.rst

@@ -1,12 +0,0 @@
-=====
- API
-=====
-
-.. Use autodoc directives to describe the *public* modules and classes
-   in the library.
-
-   If the modules are completely unrelated, create an api subdirectory
-   and use a separate file for each (see oslo.utils).
-
-   If there is only one submodule, a single api.rst file like this
-   sufficient (see oslo.i18n).

doc/source/conf.py

@@ -51,6 +51,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_reports.']
+
 # -- Options for HTML output --------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with

doc/source/index.rst

@@ -11,11 +11,18 @@ Contents
    :maxdepth: 2
 
    installation
-   api
    usage
    opts
    contributing
 
+API
+===
+
+.. toctree::
+   :maxdepth: 2
+
+   api/autoindex
+
 Release Notes
 =============
 

setup.cfg

@@ -26,6 +26,11 @@ packages =
 
 [pbr]
 warnerrors = true
+autodoc_index_modules = true
+autodoc_exclude_modules =
+    oslo_reports._i18n
+    oslo_reports._utils
+    oslo_reports.tests.*
 
 [entry_points]
 oslo.config.opts =