openstack/heat

History

rabi 2c5f6e7a80 Add intersphinx_mapping for sqlalchemy This would fix the docs build failures with sqlalchemy 1.4.27. Change-Id: Iae37cb89667ae95d93eca7ea71122b7de59cee7f		2021-11-17 12:12:52 +05:30
..
source	Add intersphinx_mapping for sqlalchemy	2021-11-17 12:12:52 +05:30
.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	Switch to newer openstackdocstheme and reno versions	2020-05-21 09:43:55 +02: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.