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:
masterbranch for the current major stable release,developbranch for next major release.
GLPI installation documentation is currently visible on ReadTheDocs.
docker compose up --remove-orphansor
make upDoc is available at http://localhost:8007/
To start with live rebuild output visible in the console (useful to see errors):
make watchYou'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 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
