History

Marcela Bonell 2a342f57b5 Fix shade reference Update the reference for the complete code sample for shade. Closes-Bug: #1537564 Change-Id: Ia75e00df48d9b47cea137d9cc413ccd80ec49fe2		2016-01-26 15:41:01 -06:00
..
samples	Fix public IP variable	2016-01-04 14:53:58 -06:00
source	Fix shade reference	2016-01-26 15:41:01 -06:00
README.rst	faafo repository moved from stackforge to openstack namespace	2015-10-20 12:54:47 +02:00
setup.cfg	Cleanup the classifieres in the setup.cfg files	2016-01-14 13:36:03 +01:00
setup.py	FirstApp: Move source directory up, rename top-level dir	2015-05-01 17:22:46 +02: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.

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.

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

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