From e9105575ff5c67ce5edd4cf1981cb383b6b9d6b8 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Thu, 23 Apr 2015 15:46:59 +0200 Subject: [PATCH] [firstapp] fix/extend the README.rst file Change-Id: I0960374a7654d409b8280631949a589290aadfbb --- openstack-firstapp/README.rst | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/openstack-firstapp/README.rst b/openstack-firstapp/README.rst index ee514bac2..9c5f5e459 100644 --- a/openstack-firstapp/README.rst +++ b/openstack-firstapp/README.rst @@ -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 ~~~~~~~~