glances/docs
2016-10-15 15:57:44 +02:00
..
_static Improve documentation (issue #872) 2016-08-26 14:05:40 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Update docs for Docker limits and actions (issue #875) 2016-10-10 21:10:10 +02:00
gw ZeroMQ plugin is now compatible with Python3 2016-10-15 15:57:44 +02:00
man Add a ZeroMQ export module #939 2016-10-15 15:24:01 +02:00
api.rst Add --disable-history tag 2016-06-02 16:30:27 +02:00
cmds.rst Add a CouchDB exporter #928 2016-09-24 17:02:33 +02: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 Cassandra/Scylla export plugin #857 2016-06-10 16:16:41 +02: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 Add a ZeroMQ export module #939 2016-10-15 15:24:01 +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

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