doc: API reference

Change-Id: Ibdb4af07c19e74a6245ec5d22f7a4de9f5d5163b

doc/source/conf.py

@@ -82,3 +82,13 @@ latex_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 # intersphinx_mapping = {'http://docs.python.org/': None}
+
+autodoc_mock_imports = [
+    # NOTE(yamamoto): We don't have midonetclient in requirements.txt.
+    'midonetclient',
+    # NOTE(yamamoto): Avoid import-time side effects.
+    #    Guru meditation now registers SIGUSR1 and SIGUSR2 by default
+    #    for backward compatibility. SIGUSR1 will no longer be registered
+    #    in a future release, so please use SIGUSR2 to generate reports.
+    'oslo_reports',
+]

doc/source/contributor/api/index.rst

@@ -0,0 +1,9 @@
+:orphan:
+
+Python API Reference
+====================
+
+.. toctree::
+   :maxdepth: 2
+
+   autoindex

doc/source/contributor/index.rst

@@ -41,3 +41,11 @@ Dashboards
    :maxdepth: 2
 
    dashboards
+
+
+Python API reference
+--------------------
+.. toctree::
+   :maxdepth: 2
+
+   api/autoindex

setup.cfg

@@ -89,4 +89,11 @@ universal = 1
 
 [pbr]
 autodoc_index_modules = True
+# REVISIT(yamamoto): alembic_migration.env is excluded because
+# it ends up in AttributeError for context.config.
+autodoc_exclude_modules =
+   midonet.neutron.db.migration.alembic_migration.env
+   midonet.neutron.db.migration.alembic_migration.versions.*
+   midonet.neutron.tests.*
 warnerrors = True
+api_doc_dir = contributor/api