6eab982dad
rst2script.sed was referenced in the Fedora getting started documentation, but the recommended way to use Heat/Openstack on Fedora is now to use RDO/packstack. Also removes the reference to rst2script.sed in the getting_started/on_fedora documentation. Also removes obsolete integration.sh script. Partial-Bug: 1338066 Change-Id: I7f2b0d84ccef324ccb8e32ca4c6d90f9a3f2dda3 |
||
---|---|---|
.. | ||
docbkx | ||
source | ||
.gitignore | ||
Makefile | ||
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.