glances

History

nicolargo be696ec8c5 Fixes a typo in command-line options docs #1425		2019-03-02 08:54:18 +01:00
..
_static	Rename Glances logs to Glances events	2018-09-09 10:22:43 +02:00
_templates	Use Sphinx for doc	2016-03-06 19:16:37 +01:00
aoa	Documentation is unclear how to get Docker information #1386 and also add a all target to the Pip install in order to install all dependencies	2019-01-20 10:56:30 +01:00
dev	Replace the wait method by a default timeout on getch	2018-11-25 21:41:00 +01:00
gw	remove duplicate JSON in help page	2018-11-01 08:49:46 +01:00
man	Fixes a typo in command-line options docs #1425	2019-03-02 08:54:18 +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
build.sh	Rebuild docs for #1305	2018-08-16 11:33:25 +02:00
cmds.rst	Fixes a typo in command-line options docs #1425	2019-03-02 08:54:18 +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	Disable plugin from Glances configuration file #1378	2018-12-27 09:58:21 +01:00
docker.rst	`pwd`.conf instead of ./glances.conf	2018-11-27 23:09:39 +01:00
faq.rst	Add a F.A.Q in the documentation. Add respond for encoding issue	2018-07-28 14:49:34 +02:00
glances.rst	Add documentation about Curses on Microsoft Windows (see issue #1312 )	2018-09-01 10:09:25 +02:00
index.rst	Add Docker doc to the index	2018-10-20 10:47:30 +02:00
install.rst	Documentation is unclear how to get Docker information #1386 and also add a all target to the Pip install in order to install all dependencies	2019-01-20 10:56:30 +01:00
make.bat	Use Sphinx for doc	2016-03-06 19:16:37 +01:00
quickstart.rst	Update docs and NEWS file	2019-01-20 10:14:45 +01: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