Name: doc
Owner: GLPI
Description: Documentation for GLPI
Created: 2015-07-16 07:20:41.0
Updated: 2018-05-22 08:45:02.0
Pushed: 2018-05-22 08:45:04.0
Homepage: http://glpi-user-documentation.rtfd.io
Size: 9766
Language: Python
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
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. It is released under the terms of the Creative Commons BY-NC-ND 4.0 International License.
GLPI users documentation is currently visible on ReadTheDocs.
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
:
rtualenv /path/to/virtualenv/files
ath/to/virtualenv/bin/activate
p install sphinx
p install recommonmark
Once all has been successfully installed, just run the following to build the documentation:
ke 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.
As you can read on top page statement; doc is currently being rewritted. It will be redacted in french; then translated to english. Once this has been done, we'll had the project on transifex to get multiple translations :)