History

zhang.lei d33227211c Correct the wrong link url Supplement for https://review.openstack.org/#/c/596603/1 Change-Id: Ie10f9b379c3cd52abc91edae9573a47fe894c290		2018-09-03 02:17:14 +00:00
..
samples	Replace dict.itervalues() with dict.values()	2017-08-04 15:31:18 +08:00
source	Correct the wrong link url	2018-09-03 02:17:14 +00:00
README.rst	Trivial: Update pypi url to new url	2018-06-07 18:11:42 +08:00
setup.cfg	[firstapp] Use https	2017-01-27 10:49:35 +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.