openstack/heat
Code Issues Proposed changes
heat/doc
History
Yosef Hoffman fd1e9f7cea Fix Broken Link in Contributing > Blueprints Doc 
The template link points to
http://git.openstack.org/cgit/openstack/heat-specs/tree/specs/template.rst
which shows a "Path not found" error. This patch instead points it to
http://git.openstack.org/cgit/openstack/heat-specs/tree/specs/templates
and explains that you should pick the template for the latest release.

Change-Id: Ibe202f351eafacdfe9112407f8611b01d5a96ada
Closes-Bug: #1612238
2016-06-30 03:36:44 -04:00
..
docbkx
Replace github with openstack git repo
2015-10-21 09:51:40 +08:00
source
Fix Broken Link in Contributing > Blueprints Doc
2016-06-30 03:36:44 -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.