nicolargo/glances
1
1
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2024-11-13 10:07:36 +03:00
Code Issues Projects Releases Wiki Activity
12ae670811
glances/docs
History
Jude 12ae670811 Add JSON export plugin
2017-08-01 19:19:14 +02: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 Update docs for load on BSD system (see issue #1116) 2017-06-27 21:13:26 +02:00
gw Add JSON export plugin 2017-08-01 19:19:14 +02:00
man New export plugin: standard and configurable Restfull exporter #1129 2017-07-30 11:05:49 +02:00
api.rst Add --disable-history tag 2016-06-02 16:30:27 +02:00
cmds.rst Port in the -c URI #996 2017-03-15 21:39:27 +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 Update doc 2017-03-12 18:52:17 +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

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