Generate API documentation from Python modules

Also brings "contributing" section toctree depth to the same level as everywhere. Change-Id: I661a0c7045fe945bfa7bd99589751c4aad63a61c
2016-03-08 15:07:44 +01:00 · 2016-03-08 15:07:44 +01:00 · 3975337875
parent 2ff09ffcce
commit 3975337875
3 changed files with 15 additions and 1 deletions
--- a/.gitignore
+++ b/.gitignore
@ -40,3 +40,4 @@ ChangeLog

 # Vagrant
 .vagrant
+doc/source/api/
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -23,10 +23,18 @@ Developer Guide
 ===============

 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2

  Contributing <contributing>

+Python API
+----------
+
+.. toctree::
+  :maxdepth: 1
+
+  api/autoindex
+
 Indices and tables
 ==================

--- a/setup.cfg
+++ b/setup.cfg
@ -80,3 +80,8 @@ source-dir = doc/source

 [pbr]
 warnerrors = True
+autodoc_index_modules = True
+autodoc_exclude_modules =
+    ironic_inspector.migrations.*
+    ironic_inspector.test.*
+    ironic.common.i18n