summaryrefslogtreecommitdiff
path: root/doc/README.rst
diff options
context:
space:
mode:
authorJoe Gordon <jogo@cloudscaling.com>2012-09-18 11:42:51 -0700
committerJoe Gordon <jogo@cloudscaling.com>2012-09-18 11:42:51 -0700
commitfba9f7666d1efe89b851dc859c127ee85851040e (patch)
treed8bb0536447c43b759bc5e350f9d4def15f61bdf /doc/README.rst
parent4844a9bdec503e19b0a06a168e3cdf63cc84e674 (diff)
downloadnova-fba9f7666d1efe89b851dc859c127ee85851040e.tar.gz
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
Diffstat (limited to 'doc/README.rst')
-rw-r--r--doc/README.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/README.rst b/doc/README.rst
index 342aba9110..a85f7bc912 100644
--- a/doc/README.rst
+++ b/doc/README.rst
@@ -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