History

Stephen Finucane ecad14368e db: Add initial alembic configuration No migrations yet: this is simply the output of 'alembic init' with some minor tweaks. A note about ordering of requirements is removed from requirements.txt: it is no longer true with the new dependency resolver introduced in pip 20.3. Signed-off-by: Stephen Finucane <stephenfin@redhat.com> Change-Id: I7790222ab5eaf6c47dd386fe472275a3037a9898		2023-03-23 11:01:07 +00:00
..
source	db: Add initial alembic configuration	2023-03-23 11:01:07 +00: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.

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.