README.md 1.54 KB
Newer Older
Johan Cwiklinski's avatar
Johan Cwiklinski committed
1
# GLPI's developper documentation
Johan Cwiklinski's avatar
Johan Cwiklinski committed
2

3
[![Build Status](https://readthedocs.org/projects/glpi-developer-documentation/badge/?version=latest)](http://glpi-developer-documentation.readthedocs.io/en/latest/?badge=latest)
4

Johan Cwiklinski's avatar
Johan Cwiklinski committed
5
Current documentation is built on top of [Sphinx documentation generator](http://sphinx-doc.org/). It is released under the terms of the <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons BY-NC-ND 4.0 International License</a>.
Johan Cwiklinski's avatar
Johan Cwiklinski committed
6

Johan Cwiklinski's avatar
Johan Cwiklinski committed
7 8 9 10
We're folllowing [GitFlow](http://git-flow.readthedocs.io/):
- ``master`` branch for the curent major stable release,
- ``develop`` branch for next major release.

11 12 13 14
## View it online!

[GLPI installation documentation is currently visible on ReadTheDocs](http://glpi-developer-documentation.rtfd.io/).

Johan Cwiklinski's avatar
Johan Cwiklinski committed
15
## Run it!
Johan Cwiklinski's avatar
Johan Cwiklinski committed
16

17
You'll just have to install [Python Sphinx](http://sphinx-doc.org/), it is generally available in distributions repositories for Linux.
Johan Cwiklinski's avatar
Johan Cwiklinski committed
18

19
If your distribution does not provide it, you could use a `virtualenv`:
Johan Cwiklinski's avatar
Johan Cwiklinski committed
20
```
Johan Cwiklinski's avatar
Johan Cwiklinski committed
21 22 23
$ virtualenv /path/to/virtualenv/files
$ /path/to/virtualenv/bin/activate
$ pip install sphinx
Johan Cwiklinski's avatar
Johan Cwiklinski committed
24 25
```

Johan Cwiklinski's avatar
Johan Cwiklinski committed
26
Once all has been successfully installed, just run the following to build the documentation:
Johan Cwiklinski's avatar
Johan Cwiklinski committed
27
```
Johan Cwiklinski's avatar
Johan Cwiklinski committed
28
$ make html
Johan Cwiklinski's avatar
Johan Cwiklinski committed
29 30
```

Johan Cwiklinski's avatar
Johan Cwiklinski committed
31
Results will be avaiable in the `build/html` directory :)
Johan Cwiklinski's avatar
Johan Cwiklinski committed
32

Johan Cwiklinski's avatar
Johan Cwiklinski committed
33
Note that it actually uses the default theme, which differs locally and on readthedocs system.
Johan Cwiklinski's avatar
Johan Cwiklinski committed
34

Johan Cwiklinski's avatar
Johan Cwiklinski committed
35
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/80x15.png" /></a>