openstack/heat
Code Issues Proposed changes
97df8bb6ca
heat/doc
History
maniksidana019 8ea5c9e5e7 Incorrect project name in installation instructions for CentOS 
Return the instructions to using the "service" project as it was before
5ecee29572, and as it is in other manual
installation instructions.

Add a note that describes the circumstances in which you need to use
"services" as the project name.

Change-Id: I76de8960ac640b9e8037879af85b84ce39b4cdcb
Co-Authored-By: Zane Bitter <zbitter@redhat.com>
Task: 28520
Story: 2003872
2018-12-19 23:01:44 +13:00
..
source Incorrect project name in installation instructions for CentOS 2018-12-19 23:01:44 +13: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 Replace pbr autodoc with sphinxcontrib-apidoc 2018-04-11 16:35:01 -04: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.