Include auto-generated API documentation in Sphinx documentation.

Change-Id: Ic2f0e4bcb315cc3f94e5077dc209431ee3e80d77
2015-06-05 14:44:59 +01:00 · 2015-06-05 14:44:59 +01:00 · 6f039df741
parent 2b4e90d8ed
commit 6f039df741
6 changed files with 20 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -1,3 +1,5 @@
 .tox/
 cloudinit.egg-info/
 *.pyc
+doc/build
+doc/source/api/
--- a/doc/source/api.rst
+++ b/doc/source/api.rst
@ -0,0 +1,7 @@
+cloud-init Python API Documentation
+===================================
+
+.. toctree::
+    :maxdepth: 2
+
+    api/autoindex
--- a/doc/source/api/README
+++ b/doc/source/api/README
@ -0,0 +1 @@
+Don't put files in here, it's intended only for auto-generated output!
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@ -2,3 +2,4 @@
 # This file is part of cloud-init.  See LICENCE file for license information.
 #
 # vi: ts=4 expandtab
+extensions = ['sphinx.ext.autodoc']
--- a/doc/source/contents.rst
+++ b/doc/source/contents.rst
@ -12,4 +12,10 @@ Summary

 `Cloud-init`_ is the *defacto* multi-distribution package that handles early initialization of a cloud instance.

+.. toctree::
+    :maxdepth: 2
+
+    api
+
+
 .. _Cloud-init: https://launchpad.net/cloud-init
--- a/setup.cfg
+++ b/setup.cfg
@ -34,3 +34,6 @@ console_scripts =
 [build_sphinx]
 source-dir = doc/source
 build-dir = doc/build
+
+[pbr]
+autodoc_index_modules = 1
				`@ -0,0 +1 @@`
				`Don't put files in here, it's intended only for auto-generated output!`