468f12152f
Adjust URLs so that they point to the new location of the RST based Cloud Administrators Guide, End User Guide, and Admin User Guide. Change-Id: Ie83f9b0324a1ae527eaa01787372b0745bde77f8 |
||
|---|---|---|
| .. | ||
| samples | ||
| source | ||
| README.rst | ||
| setup.cfg | ||
| setup.py | ||
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-libcloudOnly 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.