glances/docs
2016-07-02 11:05:23 +02:00
..
_static Add Screencast 2016-07-02 11:05:23 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Finalize New Ports Scanner plugin (issue#734) 2016-06-25 16:47:02 +02:00
gw Add Cassandra/Scylla export plugin #857 2016-06-10 16:16:41 +02:00
man CPU additionnal stats monitoring: Context switch, Interrupts... (issue #810) 2016-03-31 12:30:14 +02:00
api.rst Add --disable-history tag 2016-06-02 16:30:27 +02:00
cmds.rst Add documentation for the ports plugin 2016-06-19 11:12:40 +02:00
conf.py Add --disable-history tag 2016-06-02 16:30:27 +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 Use Sphinx for doc 2016-03-06 19:16:37 +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 Use Sphinx for doc 2016-03-06 19:16:37 +01:00
README.txt Fix Sphinx doc/man generation 2016-03-12 15:43:43 +01:00
support.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00

Building the docs
=================

First install Sphinx:

    pip install sphinx

or update it if already installed:

    pip install --upgrade sphinx

Go to the docs folder:

    cd docs

Then build the HTML documentation:

    make html

and the man page:

    LC_ALL=C make man