glances/docs
Nicolas Hennion ba68e3d8f4
Merge pull request #3275 from timrettop/sensors-docs-alias
Update sensors.rst
2025-08-30 08:49:12 +02:00
..
_static Update docs and correct an issue with UTC import 2025-07-05 10:32:11 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Update sensors.rst 2025-08-28 13:43:11 -05:00
api Update API docs 2025-08-17 18:34:31 +02:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw Filter fields to export #3258 2025-08-01 17:19:43 +02:00
man Update API docs 2025-08-17 18:34:31 +02:00
Makefile version 4.3.0.7 2025-01-03 10:20:15 +01:00
README.txt Update docs 2021-05-26 15:51:43 +02:00
build.sh Rebuild docs for #1305 2018-08-16 11:33:25 +02:00
cmds.rst Add stats about running VMS (qemu/libvirt/kvm support through virsh) #1531 2025-07-05 10:32:11 +02:00
conf.py Fix Ruff warnings in GitHub Actions 2024-11-23 13:43:11 +01:00
config.rst Create a Glances API in order to use Glances as a Python lib #3237 2025-07-12 18:16:43 +02:00
docker.rst Update docker env quote 2025-08-27 21:06:10 +01:00
faq.rst Update docs 2025-07-27 16:18:30 +02:00
glances.rst Update doc 2024-11-08 12:28:58 +01:00
index.rst Create a Glances API in order to use Glances as a Python lib #3237 2025-07-12 18:16:43 +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 Update doc 2024-11-08 12:28:58 +01: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