Files

Zane Bitter 0d1976c988 Don't reference OS::Nova::FloatingIP in the docs

Nova-network is long gone and this resource type has been hidden for
many, many releases.

Change-Id: Id6fd24dad04c5d547368ca54f7210429f27e2b37
Story: 2008978
Task: 42622

2021-06-24 16:33:02 -04:00

source

Don't reference OS::Nova::FloatingIP in the docs

2021-06-24 16:33:02 -04: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

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.