OpenStack Proposal Bot f8990871b5 Imported Translations from Zanata
For more information about this automatic import see:
https://docs.openstack.org/i18n/latest/reviewing-translation-import.html

Change-Id: I1ec5a2f6d6184ed71e4decd77b5b0475a822f4db
2017-09-17 06:53:19 +00:00
..
2017-09-17 06:53:19 +00: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.