https://github.com/glpi-project/docdev
Documentation for glpi developpers
https://github.com/glpi-project/docdev
hacktoberfest
Last synced: 7 days ago
JSON representation
Documentation for glpi developpers
- Host: GitHub
- URL: https://github.com/glpi-project/docdev
- Owner: glpi-project
- License: other
- Created: 2016-09-27T07:57:36.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-06-02T13:55:36.000Z (27 days ago)
- Last Synced: 2025-06-11T05:29:23.554Z (18 days ago)
- Topics: hacktoberfest
- Language: Python
- Homepage: http://glpi-developer-documentation.rtfd.io/
- Size: 760 KB
- Stars: 30
- Watchers: 15
- Forks: 37
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# GLPI's developer documentation
[](http://glpi-developer-documentation.readthedocs.io/en/latest/?badge=latest)
Current documentation is built on top of [Sphinx documentation generator](http://sphinx-doc.org/). It is released under the terms of the Creative Commons BY-NC-ND 4.0 International License.
We're following [GitFlow](http://git-flow.readthedocs.io/):
- ``master`` branch for the current major stable release,
- ``develop`` branch for next major release.
## View it online!
[GLPI installation documentation is currently visible on ReadTheDocs](http://glpi-developer-documentation.rtfd.io/).
## Run it!
You'll just have to install [Python Sphinx](http://sphinx-doc.org/), 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
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
```
