glances/docs
nicolargo 50818213b1 What a sexy pre-commit config file ! 2025-11-22 18:48:13 +01:00
..
_static Sensors plugin refresh by default every 10 seconds 2025-10-24 18:35:30 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Update docs for PR #3346 2025-11-16 10:54:39 +01:00
api What a sexy pre-commit config file ! 2025-11-22 18:48:13 +01:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw Add limitation to TimescaleDB export for diskio, not working for the moment 2025-11-01 16:43:56 +01:00
man Update Glances API documentation 2025-11-21 18:03:36 +01:00
Makefile Use uv instead of venv in Makefile #3304 2025-10-12 15:19:32 +02:00
README.txt Update docs 2021-05-26 15:51:43 +02:00
build.sh What a sexy pre-commit config file ! 2025-11-22 18:48:13 +01:00
cmds.rst Show long command line with arrow key #1553 2025-10-23 10:33:01 +02:00
conf.py Fix Ruff warnings in GitHub Actions 2024-11-23 13:43:11 +01:00
config.rst Make WebUI and Restful API SSL compliant #3340 2025-11-11 18:34:51 +01:00
docker.rst Update docker env quote 2025-08-27 21:06:10 +01:00
faq.rst Add info in F.A.Q about free memory 2025-11-08 09:25:26 +01:00
fetch.rst Add some fetch templates as an example 2025-11-10 11:45:33 +01:00
glances.rst Update doc 2024-11-08 12:28:58 +01:00
index.rst First release ok, need to add some tests 2025-09-21 10:03:33 +02:00
install.rst Update documentation 2025-07-05 10:32:10 +02:00
make.bat Use Sphinx for doc 2016-03-06 19:16:37 +01:00
objects.inv add intersphinx inventory 2019-06-20 11:46:07 -07:00
quickstart.rst First release ok, need to add some tests 2025-09-21 10:03:33 +02:00
support.rst Fix typos and make grammatical and stylistic edits in project documentation 2023-12-10 22:38:38 +04:00

README.txt

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