glances/docs
2017-12-26 17:04:57 +01:00
..
_static Update InfluxDB / Grafana documentation 2017-06-04 17:02:55 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Fixes a link rendering problem in load.rst 2017-10-23 14:10:41 +01:00
gw Improve documentation 2017-08-01 22:44:01 +02:00
man Add dynamic fields in all sections of the configuration file #1204 2017-12-26 17:04:57 +01:00
api.rst Add --disable-history tag 2016-06-02 16:30:27 +02:00
cmds.rst OS specific arguments should be documented and reported #1180 2017-11-03 11:58:32 +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 dynamic fields in all sections of the configuration file #1204 2017-12-26 17:04:57 +01:00
glances.rst Add CONFIGURATION section to man page 2017-02-23 11:23:43 +01:00
index.rst Update Glances global description 2016-09-04 16:53:32 +02:00
install.rst Update doc 2017-03-12 18:52:17 +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 Update documentation 2017-05-31 10:06:33 +02:00
README.txt 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

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