Files

Takashi Kajinami e910a85ebd Drop bind_host/port

The bind_host option is used only for osprofiler. It is used to
identify the host where the api service runs and can be replaced
the `host` option.

Also the port option is used only for logging.

Change-Id: Ia55b269207987c419f30a4bfc0cebcf75d8fcb4a
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>

2025-07-11 17:27:36 +09:00

source

Drop bind_host/port

2025-07-11 17:27:36 +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

Drop old excludes

2024-04-30 15:35:45 +09: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.