Skip to content

Commit

Permalink
No need for a specific sphinx version, no need for recommonmark module
Browse files Browse the repository at this point in the history
  • Loading branch information
trasher committed Oct 20, 2016
1 parent 8fb0565 commit 92a80a0
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# GLPi's developper documentation

[Show GLPi Developer Documentation online!](http://glpi-developer-documentation.readthedocs.io/en/latest) [![Build Status](https://readthedocs.org/projects/glpi-developer-documentation/badge/?version=latest)](http://glpi-developer-documentation.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://readthedocs.org/projects/glpi-developer-documentation/badge/?version=latest)](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 <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons BY-NC-ND 4.0 International License</a>.

## Run it!

You'll have to install [Python Sphinx](http://sphinx-doc.org/) 1.3 minimum, and Python Markdown module (`recommonmark`).
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 this version, you could use a `virtualenv`:
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
$ pip install recommonmark
```

Once all has been successfully installed, just run the following to build the documentation:
Expand Down

0 comments on commit 92a80a0

Please sign in to comment.