glances

mirror of https://github.com/nicolargo/glances.git synced 2026-03-14 12:00:14 -04:00

Files

Alessio Sergi 3baae1f5c4 Add the username to the log filename

Glances as system tool is often executed in a multi-user environment or
even with root privileges. Then, make the log file system-aware as well.

2016-12-27 19:49:37 +01:00

_static

Add thresholds and update docs (issue #937 )

2016-10-21 22:06:02 +02:00

_templates

Use Sphinx for doc

2016-03-06 19:16:37 +01:00

aoa

Update processlist doc

2016-12-03 18:07:24 +01:00

Update docs for ZeroMQ export module

2016-10-15 19:16:24 +02:00

man

Document logfile path in man page #969

2016-11-21 22:06:54 +01:00

api.rst

Add --disable-history tag

2016-06-02 16:30:27 +02:00

cmds.rst

Add the username to the log filename

2016-12-27 19:49:37 +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 the username to the log filename

2016-12-27 19:49:37 +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 with dependenties (issue #937 )

2016-10-21 22:11:13 +02: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

Improve documentation (issue #872 )

2016-08-26 14:05:40 +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

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