75af33a802
The template guide documentation references OS::Compute::Server in several places, and there are similar errors in the environment code comments and environment test code. Also there is a similar issue with template guide reference to Rackspace::Compute::Server, and a minor typo/spelling issue. Change-Id: Iafbf405a328bdd8222c277efe5b52d7f8f589635 Closes-Bug: #1270078 |
||
---|---|---|
.. | ||
docbkx | ||
source | ||
.gitignore | ||
Makefile | ||
README.rst |
README.rst
Building the developer docs
For user and admin docs, go to the directory doc/docbkx.
Dependencies
You'll need to install python Sphinx package and oslo.sphinx package:
sudo pip install sphinx oslo.sphinx
If you are using the virtualenv you'll need to install them in the virtualenv.
Get Help
Just type make to get help:
make
It will list available build targets.
Build Doc
To build the man pages:
make man
To build the developer documentation as HTML:
make html
Type make for more formats.
Test Doc
If you modify doc files, you can type:
make doctest
to check whether the format has problem.