os-brick/doc/source/index.rst
Stephen Finucane 4fc0a51a17 doc: Restructure docs for doc-migration
We have three populated sections:

- install
- user
- reference

There are three docs removed, as they served little useful purpose and
were mostly unreferenced.

Sphinx's 'warning-is-error' option is enabled to catch the few issues
that has snuck into the docs.

Change-Id: I04e426faf337f0b03175f439c80b3369d4066733
2017-08-08 15:44:29 +01:00

31 lines
366 B
ReStructuredText

========
os-brick
========
`os-brick` is a Python package containing classes that help with volume
discovery and removal from a host.
Installation Guide
------------------
.. toctree::
:maxdepth: 2
install/index
Usage Guide
-----------
.. toctree::
:maxdepth: 2
user/tutorial
Reference
---------
.. toctree::
:maxdepth: 2
reference/index