api-site/firstapp/README.rst
Andreas Jaeger f58477ef61 FirstApp: Move source directory up, rename top-level dir
For the RST guides, we do not need doc/source, since doc is always
empty. Use source directly.

This syncs the setup used here with openstack-manuals.

Rename top-level from openstack-firstapp to firstapp, there's no need
for the long name in this repo.

Change-Id: If4e11a4f90d580876865348e0d88b92cec4b6659
2015-05-01 17:22:46 +02:00

962 B

Writing your First OpenStack Application

This directory contains the "Writing your First OpenStack Application" tutorial.

The tutorials works with an application that can be found at: https://github.com/stackforge/faafo

/source

The /source directory contains a playground for the actual tutorial documentation. It's reStructuredText (RST), built with Sphinx.

The RST source includes conditional output logic, so specifying:

tox -e firstapp-libcloud

will invoke sphinx-build with -t libcloud, meaning sections marked .. only:: libcloud in the RST will be built, while others won't.

Sphinx and the OpenStack docs.openstack.org Sphinx Theme (openstackdocstheme) are needed to build the docs.

/samples

The code samples provided in the guide are sourced from files in this directory. There is a sub-directory for each SDK.