82963634bb
We do not need to copy source files anymore with current openstackdocstheme, unset html_show_sourcelink and html_copy_source links. Report a bug works without these as well. This reduces the amount of files we build and publish (for Install Guide from 42 MB to 39 MB), and thus speeds up building (from 44 to 41s for Install Guide) slightly. Change-Id: I5d8f332aedd03ef1b2732bcfe01d2338f78fb29d
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.