History

Rabi Mishra cb2ff87cd7 Use Fedora 31 for tests Aso configures swap as before https://review.opendev.org/750941 changed the default swap to 1024MB for jobs and this seems to resulting in high failure rate of the functional and grenade jobs. Let's configure it back to what used to before i.e 8192MB. Change-Id: Ia45e957bb24f5596a5ef16271f71ba8b77df9e42 (cherry picked from commit `f18a676792` and cherry picked from commit `f419923a0d`)		2020-10-13 12:15:55 +05:30
..
source	Use Fedora 31 for tests	2020-10-13 12:15:55 +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	Merge "Bump the openstackdocstheme extension to 1.20"	2019-09-25 15:50:37 +00: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.