nicolargo/glances
1
1
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2024-12-21 00:01:53 +03:00
Code Issues Projects Releases Wiki Activity
5141d75684
glances/docs
History
nicolargo 8d094d5ac8 Implemented but test is KO: only a part of the stats are exported... Same behavor with both client Graphyte and GraphiteSender. Perhaps the issue came from the server (docker-graphite-grafana)
2021-05-11 08:52:03 +02:00
..
_static Doc. No SMART screenshot. #1799 2021-01-30 09:29:09 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Manage multiple commands (&&) in the secure popen 2021-04-25 09:42:23 +02:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw Implemented but test is KO: only a part of the stats are exported... Same behavor with both client Graphyte and GraphiteSender. Perhaps the issue came from the server (docker-graphite-grafana) 2021-05-11 08:52:03 +02:00
man Correct ypo in InfluxDB doc sample 2021-05-06 22:03:03 +02:00
api.rst Add --disable-history tag 2016-06-02 16:30:27 +02:00
build.sh Rebuild docs for #1305 2018-08-16 11:33:25 +02:00
cmds.rst Correct typo in documentation 2021-03-13 08:53:50 +01:00
conf.py Make build reproducible #1740 2020-10-10 10:12:13 +02:00
config.rst Manpage improvement #1743 2020-10-10 10:22:31 +02:00
docker.rst version 3.1.6 2021-01-23 11:10:27 +01:00
faq.rst Add a F.A.Q in the documentation. Add respond for encoding issue 2018-07-28 14:49:34 +02:00
glances.rst Update doc 2020-03-03 22:29:39 +01:00
index.rst Add Docker doc to the index 2018-10-20 10:47:30 +02:00
install.rst Documentation is unclear how to get Docker information #1386 and also add a all target to the Pip install in order to install all dependencies 2019-01-20 10:56:30 +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
objects.inv add intersphinx inventory 2019-06-20 11:46:07 -07:00
quickstart.rst Update documentation for server protection #1657 2020-05-12 18:44:28 +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