glances/docs
2022-12-23 09:49:23 +01:00
..
_static Minor change on the help screen 2022-12-23 09:49:23 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Fix typos 2022-10-03 21:53:24 +08:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw Fix typos 2022-10-03 21:53:24 +08:00
man The open-web-browser option was missing dashes #2219 2022-12-21 13:52:07 +01:00
api.rst The open-web-browser option was missing dashes #2219 2022-12-21 13:52:07 +01:00
build.sh Rebuild docs for #1305 2018-08-16 11:33:25 +02:00
cmds.rst The open-web-browser option was missing dashes #2219 2022-12-21 13:52:07 +01:00
conf.py Revert a miss 2022-11-03 15:33:03 +01:00
config.rst Update config.rst 2022-10-03 15:43:36 -04:00
docker.rst Broken code-block sections in current Docs #2115 2022-09-03 10:55:03 +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 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 Fix typos 2022-10-03 21:53:24 +08: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