openstack/heat
Code Issues Proposed changes
heat/doc
History
chao liu 247eaa4cf3 Remove the unnecessary jeos building docs 
Since the docs below already describe how to build heat jeos, the jeos
building docs is no longer needed.

https://docs.openstack.org/heat/latest/template_guide/
software_deployment.html#software-deployment-resources

https://github.com/openstack/heat-templates/tree/master/hot/
software-config/elements

Change-Id: I5a9f68419a050e1a6215d6b5a1c18e5182e0734b
2019-12-23 13:16:09 -05:00
..
source
Remove the unnecessary jeos building docs
2019-12-23 13:16:09 -05: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
requirements.txt
tox: Keeping going with docs
2019-11-01 11:30:12 +08: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.