glances/docs
2016-03-28 14:35:12 +02:00
..
_static Use Sphinx for doc 2016-03-06 19:16:37 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Update doc to explain '?' in the folder plugin 2016-03-28 14:35:12 +02:00
gw Add default config for Riemann 2016-03-25 22:08:30 +01:00
man Correct minor PEP8 and update doc 2016-03-26 17:45:48 +01:00
api.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
cmds.rst exports: riemann export implemented and documented 2016-03-25 11:06:25 +01:00
conf.py Fix Sphinx doc/man generation 2016-03-12 15:43:43 +01:00
config.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
glances.rst Use Sphinx for man page 2016-03-06 19:16:37 +01:00
index.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
make.bat Use Sphinx for doc 2016-03-06 19:16:37 +01:00
Makefile Fix version issue with Sphinx (hopefully) 2016-03-12 11:51:42 +01:00
quickstart.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
README.txt Fix Sphinx doc/man generation 2016-03-12 15:43:43 +01:00
support.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00

Building the docs
=================

First install Sphinx:

    pip install sphinx

or update it if already installed:

    pip install --upgrade sphinx

Go to the docs folder:

    cd docs

Then build the HTML documentation:

    make html

and the man page:

    LC_ALL=C make man