423110ef6e
Update the version for Liberty, switching from date-based versioning to pre-versioning using SemVer. See http://lists.openstack.org/pipermail/openstack-dev/2015-May/065211.html and http://lists.openstack.org/pipermail/openstack-dev/2015-June/067082.html for details. Also new version was updated in resources with SupportStatus version 2015.2. Change-Id: I6a35fa0dda798fad93b804d00a46af80f08d475c |
||
---|---|---|
.. | ||
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 oslosphinx package:
sudo pip install sphinx oslosphinx
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.