From 8aa6f91440071dec75397ec5b84c41969b3c5c30 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Fri, 31 Jul 2015 10:06:46 +0200 Subject: [PATCH] Document Graphviz as a prerequisite of the firstapp doc Change-Id: I9881eba5dcf9a5ab35d4e703078b72395a743826 --- README.rst | 31 ++++++++++++++++++++++++++----- firstapp/README.rst | 22 +++++++++++++--------- 2 files changed, 39 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index decfe0eb5..ad3ab101b 100644 --- a/README.rst +++ b/README.rst @@ -20,8 +20,7 @@ In addition to these documents, this repository contains: Prerequisites ============= -To build the documentation, you must install -`Apache Maven `_. +To build the documentation, you must install `Apache Maven `_. To install Maven 3 for Ubuntu 12.04 or later or Debian 7 ("wheezy") or later:: @@ -37,6 +36,28 @@ To install Tox for Ubuntu 14.04 or later:: apt-get install python-tox python-dev libxml2-dev libxslt1-dev +"Writing your First OpenStack Application" tutorial +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To build the "Writing your first OpenStack application" tutorial, you must +install `Graphviz `_. + +To install Graphviz for Ubuntu 12.04 or later or Debian 7 ("wheezy") or later:: + + apt-get install graphviz + +On Fedora 22 and later:: + + dnf install graphviz + +On openSUSE:: + + zypper install graphviz + +On Mac OSX with Homebrew installed:: + + brew install graphviz + Build and update API docs ========================= @@ -122,9 +143,9 @@ Our community welcomes everyone who is interested in open source cloud computing and encourages you to join the `OpenStack Foundation `_. The best way to get involved with the community is to talk with others online -or at a meetup and offer contributions through our processes, -the `OpenStack wiki `_, blogs, or -on IRC at ``#openstack`` on ``irc.freenode.net``. +or at a meetup and offer contributions through our processes, the +`OpenStack wiki `_, blogs, or on IRC at ``#openstack`` on +``irc.freenode.net``. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts. diff --git a/firstapp/README.rst b/firstapp/README.rst index 088e85161..16e519b7e 100644 --- a/firstapp/README.rst +++ b/firstapp/README.rst @@ -23,23 +23,27 @@ The :code:`/source` directory contains the tutorial documentation as `reStructuredText `_ (RST). The documentation is built with `Sphinx `_. -The RST source includes conditional output logic, so specifying:: +The RST source includes conditional output logic. To invoke +:code:`sphinx-build` with :code:`-t libcloud`:: tox -e firstapp-libcloud -will invoke :code:`sphinx-build` with :code:`-t libcloud`, meaning sections -marked :code:`.. only:: libcloud` in the RST are built, while others -are not built. +Only the sections marked :code:`.. only:: libcloud` in the RST are built. -To build the documentation, you need Sphinx and the OpenStack -docs.openstack.org Sphinx Theme (openstackdocstheme). When you invoke tox, -these dependencies are automatically pulled in from the top-level :code:`test-requirements.txt`. +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 :code:`test-requirements.txt`. + +You must also install `Graphviz `_ on your build system. /samples ~~~~~~~~ -The code samples provided in the guide are sourced from files in this -directory. Each SDK has its own subdirectory. +The code samples in the guide are located in this directory. The code samples +for each SDK are located in separate subdirectories. /build-libcloud ~~~~~~~~~~~~~~~