openstack/heat
Code Issues Proposed changes
26a20de88c
heat/doc
History
Takashi Kajinami c881da8b87 Use Block Storage API v3 instead of API v2 
Block Storage API v2 was deprecated during Pike cycle and is being
removed during Xena cycle, and current v3 API should be used instead.
Unused volume_client and network_client in integration test code are
also removed by this change.

Note:
granade tests is made non-voting temporally until the same issue is
fixed in stable/victoria.

Depends-on: https://review.opendev.org/802150/
Change-Id: I6a2b5afa13480791971bbd8bba1f43b9f2db8294
(cherry picked from commit 1828df32fa)

Move testing to Fedora 33

Now that the gate is unblocked, we can also test F33 for gating purposes
here.

Change-Id: Ie1c9075623d85b27aaf1ac67a3063e219726bc6f
(cherry picked from commit 6a9c35d898)
2021-08-26 09:22:09 +05:30
..
source Use Block Storage API v3 instead of API v2 2021-08-26 09:22:09 +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

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.