diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst new file mode 100644 index 000000000..25686f80e --- /dev/null +++ b/doc/source/api/index.rst @@ -0,0 +1,4 @@ +.. toctree:: + :maxdepth: 1 + + undercloud \ No newline at end of file diff --git a/doc/source/api/undercloud.rst b/doc/source/api/undercloud.rst new file mode 100644 index 000000000..852737835 --- /dev/null +++ b/doc/source/api/undercloud.rst @@ -0,0 +1,8 @@ +=================== + :mod:`undercloud` +=================== + +.. automodule:: instack_undercloud.undercloud + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/index.rst b/doc/source/index.rst index 074a98279..600ee18bc 100644 --- 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`