Giter Club home page Giter Club logo

docdev's Introduction

GLPI's developer documentation

Build Status

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:

  • 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.

Run it!

You'll just have to install Python Sphinx, 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

Creative Commons License

docdev's People

Contributors

trasher avatar cconard96 avatar anaelmobilia avatar cedric-anne avatar tomolimo avatar orthagh avatar kl3sk avatar remicollet avatar btry avatar yllen avatar adrienclairembault avatar tsmr avatar filipemenezes avatar al-alec avatar ddurieux avatar flegastelois avatar thibaudbayol avatar chpego avatar nqb avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.