Tom Fifield bd3b00a532 firstapp - move libcloud sec5 to sample file
The Block Storage Section, originally written for libcloud
now has support for other SDKs. libcloud should be treated
the same as other SDKs, so this patch simply moves the
code samples into a dedicated file, as per the per all
other sections.

Change-Id: Ide9e8f29aec37b0410d133549679406ecdc0cce2
2015-11-23 16:14:41 +08:00
..

Writing Your First OpenStack Application

This directory contains the "Writing Your First OpenStack Application" tutorial.

The tutorials work with an application that can be found in the openstack/faafo repository.

Prerequisites

To build the documentation, you must install the Graphviz package.

/source

The /source directory contains the tutorial documentation as reStructuredText (RST).

To build the documentation, you must install Sphinx and the OpenStack docs.openstack.org Sphinx theme (openstackdocstheme). When you invoke tox, these dependencies are automatically pulled in from the top-level test-requirements.txt.

You must also install Graphviz on your build system.

The RST source includes conditional output logic. The following command invokes sphinx-build with -t libcloud:

tox -e firstapp-libcloud

Only the sections marked .. only:: libcloud in the RST are built.

/samples

The code samples in this guide are located in this directory. The code samples for each SDK are located in separate subdirectories.

/build-libcloud

The HTML documentation is built in this directory. The .gitignore file for the project specifies this directory.