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
9dc133d5ae
glances/docs
History
Nicolas Hennion 95facc4984
Merge pull request #1681 from calebmarchent/sensors_grammar_fix 
Fix grammar in sensors documentation
2020-07-20 08:54:54 +02:00
..
_static Convert JPEG to PNG images (for documentation) 2020-03-23 16:23:43 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Merge pull request #1681 from calebmarchent/sensors_grammar_fix 2020-07-20 08:54:54 +02:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw Feature request: Include hostname in all (e.g. kafka) exports #1594 2020-02-27 15:17:24 +01:00
man Update documentation for server protection #1657 2020-05-12 18:44:28 +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 Add --enable-plugin options from the command line 2019-10-12 11:21:47 +02:00
conf.py add intersphinx inventory 2019-06-20 11:46:07 -07:00
config.rst log file under public/shared tmp/ folders must not have deterministic name #1575 2019-12-26 11:08:57 +01:00
docker.rst docker glances container shows container's own network traffic #1435 2019-07-03 22:41:54 +02: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