Add basic API docs

Flesh out the placeholder docs with at least a little content. Change-Id: I3c25f993b2f680b5ff7c872c4ec236ae9781e199
2015-09-15 20:56:03 +00:00 · 2015-09-15 20:56:03 +00:00 · e0ffaa210d
parent 823cec005b
commit e0ffaa210d
3 changed files with 33 additions and 0 deletions
--- a/doc/source/api/index.rst
+++ b/doc/source/api/index.rst
@ -0,0 +1,4 @@
+.. toctree::
+   :maxdepth: 1
+
+   undercloud
--- a/doc/source/api/undercloud.rst
+++ b/doc/source/api/undercloud.rst
@ -0,0 +1,8 @@
+===================
+ :mod:`undercloud`
+===================
+
+.. automodule:: instack_undercloud.undercloud
+  :members:
+  :undoc-members:
+  :show-inheritance:
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -1,3 +1,24 @@
 Welcome to |project| documentation
 ====================================

+The instack-undercloud project has code and diskimage-builder
+elements for deploying a TripleO undercloud to an existing system.
+
+See the `TripleO documentation`_ for the full end-to-end workflow.
+
+.. _`TripleO documentation`: http://docs.openstack.org/developer/tripleo-docs/
+
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   api/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`