Add basic API docs
Flesh out the placeholder docs with at least a little content. Change-Id: I3c25f993b2f680b5ff7c872c4ec236ae9781e199
This commit is contained in:
parent
823cec005b
commit
e0ffaa210d
4
doc/source/api/index.rst
Normal file
4
doc/source/api/index.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
undercloud
|
8
doc/source/api/undercloud.rst
Normal file
8
doc/source/api/undercloud.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
===================
|
||||||
|
:mod:`undercloud`
|
||||||
|
===================
|
||||||
|
|
||||||
|
.. automodule:: instack_undercloud.undercloud
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
@ -1,3 +1,24 @@
|
|||||||
Welcome to |project| documentation
|
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`
|
||||||
|
Loading…
Reference in New Issue
Block a user