nicolargo/glances
1
1
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2024-12-29 20:21:35 +03:00
Code Issues Projects Releases Wiki Activity
9650ce0d67
glances/docs
History
nicolargo 9650ce0d67 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
..
_static Update docs for the new IRQ plugin 2016-08-22 09:14:41 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Update docs for the new IRQ plugin 2016-08-22 09:14:41 +02:00
gw Update InfluxDB doc: use tsm1 engine (issue #883) 2016-07-05 14:42:10 +02:00
man 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
api.rst Add --disable-history tag 2016-06-02 16:30:27 +02:00
cmds.rst 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
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 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

README.txt 

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