Andreas Jaeger 7d75305b6d Reorganize appendix for toc
Make index more compact with having a single toc for everything.
Remove also search, we have that in the navigation.

See also I6bf4e94f6c0A569850cca6558be672de298bb208c.

Change-Id: Ideb383715063aba7aa7781b876c471c6a1d4f331
2017-03-31 07:32:13 +02:00
..
2017-03-31 07:32:13 +02:00
2017-01-27 10:49:35 +01: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.