Fix doc/README.rst to render properly

Fix doc/README.rst to work on github:
https://github.com/openstack/nova/tree/master/doc

Change-Id: Ib589607014158c2a5af26bd137e252e5a0de30c6
This commit is contained in:
Joe Gordon 2012-09-18 11:42:51 -07:00
parent 4844a9bdec
commit fba9f7666d
1 changed files with 9 additions and 8 deletions

View File

@ -8,15 +8,15 @@ Included documents:
Building the docs
-----------------
From the root nova director:
From the root nova director::
python setup.py build_sphinx
python setup.py build_sphinx
Building just the man pages
---------------------------
from the root nova director:
from the root nova director::
python setup.py build_sphinx -b man
python setup.py build_sphinx -b man
Installing the man pages
@ -25,7 +25,8 @@ 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
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