openstack/heat
Code Issues Proposed changes
heat/doc
History
Zane Bitter 6e7b3be2b8 Add a make_url intrinsic function 
A large proportion of uses of the str_replace function is to build URLs out
of various components from various sources. This is invariably brittle,
with a failure to escape special characters, deal with IPv6 addresses, and
so on. The make_url function provides a both a tidier interface and correct
handling of these edge cases.

Change-Id: I61b6dff01cd509b3d1c54bca118632c276569f4e
2017-03-14 15:34:31 -04:00
..
docbkx
Replace github with openstack git repo
2015-10-21 09:51:40 +08:00
source
Add a make_url intrinsic function
2017-03-14 15:34:31 -04: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.