openstack/nova
Code Issues Proposed changes

Add README for doc folder

Browse Source 
In preparation for more more man pages

Change-Id: I55a9d332e5cbba90ff1e2a2cb0c0d24ae35fba5b
This commit is contained in:
Joe Gordon 2012-09-13 17:39:00 -07:00
parent 9d791c1225
commit 6dc8b4573a
2 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -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/

31
doc/README.rst Normal file
View File

@ -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