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.
Each command exists in two flavours: with Docker (docker- prefix, only Docker required) or directly on your machine (Sphinx required).
| Docker | Your machine | What it does |
|---|---|---|
make docker-build |
make build |
Build the HTML documentation in build/html |
make docker-watch |
make watch |
Serve the documentation on http://localhost:8007/, rebuilt on change |
make docker-lint |
make lint |
Check RST syntax and references; fails on any warning |
Run make alone to list the available commands.
Nothing to install but Docker: each command runs in a throwaway container, and the image is built on first use.
Install Sphinx, sphinx-autobuild and the GLPI theme, for example in a virtual environment:
python3 -m venv .venv
. .venv/bin/activate
pip install sphinx sphinx-autobuild -r requirements.txt