api-site/firstapp/README.rst
Stefano Maffulli c5fa73302b Adding tutorial for OpenStack Shade library
Fixed also a bunch of English-language to the getting started text

co-authored-by: Diane Fleming

Change-Id: I9318cdefb628a7441a984f7c8f200202b41430dd
2015-08-11 11:35:22 -07:00

1.5 KiB

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 at https://github.com/stackforge/faafo.

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.