glances/docs
Georgiy Timchenko 30354d623e Fix typos in project documentation
Several typos were found and corrected in the project documentation. These changes affect the following files:

- docs/cmds.rst
- docs/config.rst

These corrections improve the readability and accuracy of the documentation, making it more accessible and understandable for users and developers.
2023-12-10 14:02:43 +04:00
..
_static Update Flame 2023-10-29 08:59:13 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Wifi plugin is back again (only current hotspot using the nmcli command line or the current wifi interface using the /proc/net/wireless file - Related to #1377 2023-07-25 16:04:38 +02:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw CouchDB migration from CouchDB to PyCouchDB library #2570 2023-10-08 10:10:13 +02:00
man Update docs. Correct Sphinx path. 2023-11-01 08:53:44 +01:00
api.rst Update docs. Correct Sphinx path. 2023-11-01 08:53:44 +01:00
build.sh Rebuild docs for #1305 2018-08-16 11:33:25 +02:00
cmds.rst Fix typos in project documentation 2023-12-10 14:02:43 +04:00
conf.py Error while generating the documentation (ModuleNotFoundError: No module named 'glances') #2391 2023-05-13 15:30:09 +02:00
config.rst Fix typos in project documentation 2023-12-10 14:02:43 +04:00
docker.rst Apply #2563 on develop branch 2023-10-07 10:46:23 +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. Correct Sphinx path. 2023-11-01 08:53:44 +01:00
objects.inv add intersphinx inventory 2019-06-20 11:46:07 -07:00
quickstart.rst Fix typos 2023-07-08 17:43:33 +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