api-site/firstapp

Writing your first OpenStack application

This tutorial works with the First App Application for OpenStack.

Prerequisites

To build the documentation, install Python Tox.

To install Tox for Ubuntu 14.04 and later:

apt-get install python-tox python-dev libxml2-dev libxslt1-dev

Structure

/source

The /source directory contains the tutorial documentation as reStructuredText (RST). The documentation is built with Sphinx.

The RST source includes conditional output logic. To invoke sphinx-build with -t libcloud:

tox -e firstapp-libcloud

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

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.

/samples

The code samples in the 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. This directory is included in the project .gitignore.