openstack/heat
Code Issues Proposed changes
8a4df57c37
heat/doc
History
huangtianhua 8a4df57c37 Change namespace 'ceilometer' to 'aodh' 
Change namespace of some files to '*aodh*' instead of '*ceilometer*'.

Blueprint migrate-to-use-aodh-for-alarms

Change-Id: I2c4d565ded5f9f7146b23479acd2702f976b8833
2016-07-04 03:22:49 +00:00
..
docbkx Replace github with openstack git repo 2015-10-21 09:51:40 +08:00
source Change namespace 'ceilometer' to 'aodh' 2016-07-04 03:22:49 +00: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.