GLPI's developer documentation

Current documentation is built on top of Sphinx documentation generator. It is released under the terms of the Creative Commons BY-NC-ND 4.0 International License.

We're following GitFlow:

• master branch for the current major stable release,
• develop branch for next major release.

View it online!

GLPI installation documentation is currently visible on ReadTheDocs.

Run it!

Using Docker

docker compose up --remove-orphans

or

make up

This only starts the container; it does not serve the documentation yet.

To build and serve the documentation, with live rebuild on changes and console output (useful to see errors):

make watch

Doc is then available at http://localhost:8007/

Using your machine

You'll just have to install Python Sphinx, it is generally available in distributions repositories for Linux.

If your distribution does not provide it, you could use a virtualenv:

$ virtualenv /path/to/virtualenv/files
$ /path/to/virtualenv/bin/activate
$ pip install sphinx

Once all has been successfully installed, just run the following to build the documentation:

$ make html

Results will be available in the build/html directory :)

Note that it actually uses the default theme, which differs locally and on readthedocs system.

Autobuild

Autobuild automatically rebuild and refresh the current page on edit. To use it, you need the sphinx-autobuild module:

$ pip install sphinx-autobuild

You can then use the livehtml command:

$ make livehtml