57c1cff9ca
This also includes a bunch of updates to the actual samples that have become stale as things have changed in the tree and naughty developers haven't updated the docs. This new bit of logic in the samples test should help prevent that in the future. In order to verify the static doc/api_samples files, this adds a new method to the base test, which allows the subclasses to refine their subs into pattern matches after the server response is verified, and before the doc/api_samples file is verified. Change-Id: Ie46b24a65145c407d46974b63a97a84911223547
OpenStack Nova Documentation README
Included documents:
- developer reference guide(devref)
- man pages
Building the docs
From the root nova director:
python setup.py build_sphinxBuilding just the man pages
from the root nova director:
python setup.py build_sphinx -b manInstalling 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