GithubHelp home page GithubHelp logo

neoloop / doc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from glpi-project/doc

0.0 0.0 0.0 9.7 MB

Documentation for GLPI

Home Page: http://glpi-user-documentation.rtfd.io

License: Other

Makefile 30.22% Batchfile 29.49% Python 40.29%

doc's Introduction

GLPi's 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. It is released under the terms of the Creative Commons BY-NC-ND 4.0 International License.

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 sphinx
$ pip install recommonmark

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.

Translations...

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 :)

Creative Commons License

doc's People

Contributors

yllen avatar trasher avatar moyooo avatar orthagh avatar bzg avatar jmdoleans avatar btry avatar chpego 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.