ironic-inspector/doc/source/index.rst
Dmitry Tantsur 99732e5297 Numerous improvements in the documentation
* Flatten the directory structure (we don't have that many doc files)
* Dropped HTTP-API from the root so that we don't maintain 2 copies
* Fixed links all over the place
* Leave one copy of README text in the root and include it in docs
* Update 'tox -epep8' to also check docs

Change-Id: Ic14cb73668544be27c6b96b384f93b239e49acfd
2015-12-02 18:07:22 +01:00

36 lines
445 B
ReStructuredText

.. include:: ../../README.rst
User Guide
===========
.. toctree::
:maxdepth: 2
Workflow <workflow>
Usage <usage>
HTTP API <http-api>
Troubleshooting <troubleshooting>
Admin Guide
===========
.. toctree::
:maxdepth: 2
Installation <install>
Developer Guide
===============
.. toctree::
:maxdepth: 1
Contributing <contributing>
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`