openstack/heat

History

Takashi Kajinami 1292ebb1bf Add wsgi module The wsgi_script feature is being removed because of some changes in underlying python packaging tooling. This makes heat to vendor the wsgi module which can be used instead of the wsgi script, according to the proposed community goal[1]. The existing wsgi scripts are kept now for smooth transition. [1] https://review.opendev.org/c/openstack/governance/+/902807 Depends-On: https://review.opendev.org/c/openstack/devstack/+/902758 Change-Id: I4dc92f06610753171215913180ce7cdab15ba047		2024-09-30 06:34:26 +00:00
..
source	Add wsgi module	2024-09-30 06:34:26 +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
requirements.txt	Drop old excludes	2024-04-30 15:35:45 +09:00

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.

Just type make to get help:

make

It will list available build targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

If you modify doc files, you can type:

make doctest

to check whether the format has problem.