heat/doc
Takashi Kajinami 0e51506419 Bump Fedora image used in CI
Fedora 36 is already EOLed so we should use more recent version.

Because guest enters to emergency shell when Fedora 38 (latest at
the time of writing) is used, we select Fedora 37 for now.

Change-Id: Ie0876080c771fb124d4dd36f803fbfd3b108e240
2023-09-07 21:20:31 +09:00
..
source Bump Fedora image used in CI 2023-09-07 21:20:31 +09: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 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.

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.