openstack/api-site
Code Issues Proposed changes

[firstapp] fix/extend the README.rst file

Browse Source 
Change-Id: I0960374a7654d409b8280631949a589290aadfbb
This commit is contained in:
Christian Berendt 2015-04-23 15:46:59 +02:00
parent f7feabd151
commit e9105575ff
1 changed files with 8 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
openstack-firstapp/README.rst
View File

@ -2,38 +2,28 @@
Writing your First OpenStack Application
========================================
This repo contains the "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
/bin
~~~~
This document was initially written in 'sprint' style.
/bin contains some useful scripts for the sprint, such as
pads2files which faciliates the creation of files from
an etherpad server using its API.
/doc
~~~~
/doc contains a playground for the actual tutorial documentation
It's RST, built with sphinx.
The :code:`/doc` 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 libcloud
tox -e openstack-firstapp-libcloud
will invoke sphinx-build with -t libcloud, meaning sections
marked .. only:: libcloud in the RST will be built, while others
will invoke :code:`sphinx-build` with :code:`-t libcloud`, meaning sections
marked :code:`.. only:: libcloud` in the RST will be built, while others
won't.
sphinx and openstackdoctheme are needed to build the docs
Sphinx and the OpenStack docs.openstack.org Sphinx Theme (openstackdocstheme)
are needed to build the docs.
/samples
~~~~~~~~