glances

History

nicolargo b80ff98de3 Update docs and requirements files		2017-01-01 14:14:20 +01:00
..
_static	Update documentation for the new GPU plugin	2016-12-29 17:21:55 +01:00
_templates	Use Sphinx for doc	2016-03-06 19:16:37 +01:00
aoa	Add GPU to the document sidebar menu	2016-12-29 17:27:49 +01:00
gw	Update docs for ZeroMQ export module	2016-10-15 19:16:24 +02:00
man	Update docs and requirements files	2017-01-01 14:14:20 +01:00
Makefile	Fix version issue with Sphinx (hopefully)	2016-03-12 11:51:42 +01:00
README.txt	Improve documentation (issue #872 )	2016-08-26 14:05:40 +02:00
api.rst	Add --disable-history tag	2016-06-02 16:30:27 +02:00
cmds.rst	Correct hotkeys d, f, l, n	2016-12-31 18:41:58 +01:00
conf.py	Change the IRQ shortcut key from R to Q. R is alread used for the RAID plugins. Also update the docs for the IRQ plugin. Last but not leat, change the ReadTheDoc theme	2016-08-23 20:12:49 +02:00
config.rst	Add configuration file template path in the doc	2016-12-30 10:10:48 +01:00
glances.rst	Add Cassandra/Scylla export plugin #857	2016-06-10 16:16:41 +02:00
index.rst	Update Glances global description	2016-09-04 16:53:32 +02:00
install.rst	Update docs and requirements files	2017-01-01 14:14:20 +01:00
make.bat	Use Sphinx for doc	2016-03-06 19:16:37 +01:00
quickstart.rst	Improve documentation (issue #872 )	2016-08-26 14:05:40 +02:00
support.rst	Use Sphinx for doc	2016-03-06 19:16:37 +01:00

README.txt

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

First install Sphinx and the RTD theme:

    pip install sphinx sphinx_rtd_theme

or update it if already installed:

    pip install --upgrade sphinx sphinx_rtd_theme

Go to the docs folder:

    cd docs

Then build the HTML documentation:

    make html

and the man page:

    LC_ALL=C make man