Walter A. Boring IV b3a392e5a2 Update the documentation for os-brick

This patch intends to update the base documenation that is built
for the os-brick library.  It includes the API documentation,
changelog, tutorial.

You can generate the documentation by running:
tox -edocs

DocImpact
Change-Id: Ia0fe0118207bbdc3cf698dfe09c0b71ebddd57f3

2015-02-19 14:37:13 -08:00

1.0 KiB

Raw Blame History

os-brick Documenation

Overview

os-brick is a Python package containing classes that help with volume discovery and removal from a host.

installation: Instructions on how to get the distribution.
tutorial: Start here for a quick overview.
api/index: The complete API Documenation, organized by module.

Changes

see the changelog for a full list of changes to os-brick.

About This Documentation

This documentation is generated using the Sphinx documentation generator. The source files for the documentation are located in the doc/ directory of the os-brick distribution. To generate the docs locally run the following command from the root directory of the os-brick source.

$ python setup.py doc

installation tutorial changelog api/index

Indices and tables

genindex
modindex
search

1.0 KiB Raw Blame History