From 6dc8b4573ad539c93794f9fbb6bea1189f0abad0 Mon Sep 17 00:00:00 2001
From: Joe Gordon <jogo@cloudscaling.com>
Date: Thu, 13 Sep 2012 17:39:00 -0700
Subject: [PATCH] Add README for doc folder

In preparation for more more man pages

Change-Id: I55a9d332e5cbba90ff1e2a2cb0c0d24ae35fba5b
---
 README.rst     |  2 +-
 doc/README.rst | 31 +++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+), 1 deletion(-)
 create mode 100644 doc/README.rst

diff --git a/README.rst b/README.rst
index e39c83ed7cd8..0e2a216f014c 100644
--- a/README.rst
+++ b/README.rst
@@ -39,7 +39,7 @@ the master GIT repository at:
 
    http://github.com/openstack/nova
 
-Developers should also join the dicussion on the mailing list,
+Developers should also join the discussion on the mailing list,
 at:
 
    https://lists.launchpad.net/openstack/
diff --git a/doc/README.rst b/doc/README.rst
new file mode 100644
index 000000000000..342aba9110f6
--- /dev/null
+++ b/doc/README.rst
@@ -0,0 +1,31 @@
+OpenStack Nova Documentation README
+===================================
+Included documents:
+
+- developer reference guide(devref)
+- man pages
+
+
+Building the docs
+-----------------
+From the root nova director:
+
+    python setup.py build_sphinx
+
+Building just the man pages
+---------------------------
+from the root nova director:
+
+    python setup.py build_sphinx -b man
+
+
+Installing the man pages
+-------------------------
+After building the man pages, they can be found in ``doc/build/man/``.
+You can install the man page onto your system by following the following steps:
+
+Example for ``nova-manage``::
+    # mkdir /usr/local/man/man1
+    # install -g 0 -o 0 -m 0644 doc/build/man/nova-manage.1  /usr/local/man/man1/nova-manage.1
+    # gzip /usr/local/man/man1/nova-manage.1
+    # man nova-manage