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:
parent
c8e6e7d357
commit
5f8f55786e
@ -8,15 +8,15 @@ Included documents:
|
|||||||
|
|
||||||
Building the docs
|
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
|
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
|
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:
|
You can install the man page onto your system by following the following steps:
|
||||||
|
|
||||||
Example for ``nova-manage``::
|
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
|
mkdir /usr/local/man/man1
|
||||||
# gzip /usr/local/man/man1/nova-manage.1
|
install -g 0 -o 0 -m 0644 doc/build/man/nova-manage.1 /usr/local/man/man1/nova-manage.1
|
||||||
# man nova-manage
|
gzip /usr/local/man/man1/nova-manage.1
|
||||||
|
man nova-manage
|
||||||
|
Loading…
Reference in New Issue
Block a user