openstack
/
api-site
Code Issues Proposed changes

Document Graphviz as a prerequisite of the firstapp doc 

Change-Id: I9881eba5dcf9a5ab35d4e703078b72395a743826
This commit is contained in:
Christian Berendt 2015-07-31 10:06:46 +02:00 committed by Diane Fleming
parent c3d000dded
commit 8aa6f91440
2 changed files with 39 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.rst
View File

@ -20,8 +20,7 @@ In addition to these documents, this repository contains:
Prerequisites
=============
To build the documentation, you must install
`Apache Maven <http://maven.apache.org/>`_.
To build the documentation, you must install `Apache Maven <http://maven.apache.org/>`_.
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 <http://www.graphviz.org/>`_.
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 <http://www.openstack.org/join>`_.
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 <http://wiki.openstack.org>`_, blogs, or
on IRC at ``#openstack`` on ``irc.freenode.net``.
or at a meetup and offer contributions through our processes, the
`OpenStack wiki <http://wiki.openstack.org>`_, 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.

22
firstapp/README.rst
View File

@ -23,23 +23,27 @@ The :code:`/source` directory contains the tutorial documentation as
`reStructuredText <http://docutils.sourceforge.net/rst.html>`_ (RST). The
documentation is built with `Sphinx <http://sphinx-doc.org/>`_.
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 <http://sphinx-doc.org/>`_
and the
`OpenStack docs.openstack.org Sphinx theme (openstackdocstheme) <https://pypi.python.org/pypi/openstackdocstheme>`_.
When you invoke tox, these dependencies are automatically pulled in from the
top-level :code:`test-requirements.txt`.
You must also install `Graphviz <http://www.graphviz.org/>`_ 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
~~~~~~~~~~~~~~~