glances/docs
2022-07-28 18:23:58 +02:00
..
_static version 3.2.7 2022-07-28 18:00:59 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Resolve conflict after develop merge 2022-07-09 14:03:12 +02:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw feat: add note about host 2022-07-14 18:25:20 +01:00
man version 3.2.7 2022-07-28 18:00:59 +02:00
api.rst Resolv conflict from master 2022-07-28 18:10:35 +02:00
build.sh Rebuild docs for #1305 2018-08-16 11:33:25 +02:00
cmds.rst Update docs for new shortcut 2022-07-10 18:42:34 +02:00
conf.py Make build reproducible #1740 2020-10-10 10:12:13 +02:00
config.rst Also search glances.conf file in /usr/share/doc/glances/glances.conf #1862 2021-07-04 09:47:45 +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 Update docs 2021-05-26 15:51:43 +02:00
objects.inv add intersphinx inventory 2019-06-20 11:46:07 -07:00
quickstart.rst Add a Json stdout option #2060 2022-06-12 10:11:46 +02:00
README.txt Update docs 2021-05-26 15:51:43 +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:

    make venv

or update it if already installed:

    make venv-upgrade

Go to the docs folder:

    cd docs

Then build the HTML documentation:

    make html

and the man page:

    LC_ALL=C make man