81b1dbebdf
This is the external Brick library that came from Cinder's codebase. It's intended to be used as a standalone library and subproject of Cinder.
51 lines
1.0 KiB
ReStructuredText
51 lines
1.0 KiB
ReStructuredText
Brick |release| Documenation
|
|
============================
|
|
|
|
Overview
|
|
--------
|
|
**Brick** is a Python package containing classes that help
|
|
with volume discover and creation for local storage.
|
|
|
|
:doc:`installation`
|
|
Instructions on how to get the distribution.
|
|
|
|
:doc:`tutorial`
|
|
Start here for a quick overview.
|
|
|
|
:doc:`api/index`
|
|
The complete API Documenation, organized by module.
|
|
|
|
|
|
Changes
|
|
-------
|
|
see the :doc:`changelog` for a full list of changes to **Brick**.
|
|
|
|
About This Documentation
|
|
------------------------
|
|
This documentation is generated using the `Sphinx
|
|
<http://sphinx.pocoo.org/>`_ documentation generator. The source files
|
|
for the documentation are located in the *doc/* directory of the
|
|
**Brick** distribution. To generate the docs locally run the
|
|
following command from the root directory of the **Brick** source.
|
|
|
|
.. code-block:: bash
|
|
|
|
$ python setup.py doc
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
installation
|
|
tutorial
|
|
changelog
|
|
api/index
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|