gonzaleztroyano / doc

Documentation for GLPI

GLPI user documentation

Documentation is being rewrited... Some parts may be really out of date, some links can be broken, ...

Current documentation is built on top of Sphinx documentation generator.

Documentation is released under the terms of the Creative Commons License Attribution-ShareAlike 3.0 France CC BY-SA 3.0 FR.

View it online!

GLPI users documentation is currently visible on ReadTheDocs.

Run it!

You'll have to install Python Sphinx 1.3 minimum, and Python Markdown module (recommonmark) (until rewrite to restructured text will be complete).

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

$ virtualenv /path/to/virtualenv/files
$ /path/to/virtualenv/bin/activate
$ pip install -r requirements.txt

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

$ make html

Results will be avaiable 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

Translations...

Join the project on Transifex.