openstack/heat
Code Issues Proposed changes
Files
6a1ff532f9b8f456a9fe49b989a58a844ee731f9
heat/doc
History
tengqm e11ecb4f43 Fix documentation on Fn::Base64 function 
The documentation says that the 'Fn::Base64' function converts an
input string into Base64, while the implementation is actually a
pass-through.  This patch fixes the documentation to avoid confusions
caused to users.

Change-Id: I643e73f7ed258da06d09f17a3302a258e3303414
Closes-Bug: 1377323
2014-12-01 18:51:08 +08:00
..
docbkx
Remove heat-cli-guide
2014-01-15 08:41:48 +01:00
source
Fix documentation on Fn::Base64 function
2014-12-01 18:51:08 +08:00
.gitignore
A new documention structure, ready for contributions
2012-12-19 10:22:35 +13:00
Makefile
Makefile option to build xml docs
2014-07-02 22:08:01 +02:00
README.rst
Switch over to oslosphinx
2014-02-13 18:45:57 +01:00

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.