Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add README for doc folder

In preparation for more more man pages

Change-Id: I55a9d332e5cbba90ff1e2a2cb0c0d24ae35fba5b
  • Loading branch information...
commit 6dc8b4573ad539c93794f9fbb6bea1189f0abad0 1 parent 9d791c1
@jogo jogo authored
Showing with 32 additions and 1 deletion.
  1. +1 −1  README.rst
  2. +31 −0 doc/README.rst
View
2  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/
View
31 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
Please sign in to comment.
Something went wrong with that request. Please try again.