From 5f8f55786ed9f36c97d13a2e83a216aade228214 Mon Sep 17 00:00:00 2001 From: Joe Gordon Date: Tue, 18 Sep 2012 11:42:51 -0700 Subject: [PATCH] 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 --- doc/README.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index 342aba911..a85f7bc91 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