[ganeti/ganeti_webmgr] 3e58436 README: Add instructions on how to build documentation

[g...@osuosl.org]

The branch, bug/15195 has been updated

Old revision: 205eceb36b9fd467729b6bb5b17d1e4f6d1069a9, new revision: 3e58436feac1622a18085c590379b11078023af4.
via 3e58436feac1622a18085c590379b11078023af4 (commit)
from 205eceb36b9fd467729b6bb5b17d1e4f6d1069a9 (commit)

- Log -----------------------------------------------------------------
commit 3e58436feac1622a18085c590379b11078023af4
Author: Chance Zibolski <chance....@gmail.com>
Date: Thu Jan 2 14:57:43 2014 -0800

README: Add instructions on how to build documentation


Summary of changes:
README.rst | 18 ++++++++++++++++++
1 files changed, 18 insertions(+), 0 deletions(-)

diff --git a/README.rst b/README.rst
index b10ff26..d5240fe 100644
--- a/README.rst
+++ b/README.rst
@@ -5,6 +5,24 @@ Ganeti Web Manager
Ganeti Web Manager is a Django-based web application that allows administrators
and clients access to their ganeti clusters.

+Building the Documentation
+==========================
+
+Our documentation is written in ReStructuredText and built using Sphinx. First
+you will need to install the dependencies to a virtualenv or to your system's
+python installation::
+
+ pip install -r requirements/dev.txt
+
+Then you will need to run the following commands to build the documentation::
+
+ cd docs/
+ make html
+
+The documentation will be located at ``docs/build/html/`` as html files.
+If you open ``index.html`` with your web browser, it will take you to the
+table of contents.
+

Installation
------------