glances/docs
2017-02-23 12:52:35 +01:00
..
_static Change the README file 2017-01-07 15:55:32 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Fix formatting for CPU stats documentation 2017-02-23 12:52:35 +01:00
gw version 2.8.1 2017-02-06 18:12:58 +01:00
man First part of the implementation of the issue #1029 (all but the Web UI integration 2017-02-12 18:49:25 +01:00
api.rst Add --disable-history tag 2016-06-02 16:30:27 +02:00
cmds.rst OS X -> macOS 2017-01-18 20:01:00 +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 Improve documentation about TEMP on Windows 2017-02-23 11:18:33 +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 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
Makefile Fix version issue with Sphinx (hopefully) 2016-03-12 11:51:42 +01:00
quickstart.rst version 2.8.1 2017-02-06 18:12:58 +01: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