nicolargo/glances
1
1
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2024-12-11 09:55:33 +03:00
Code Issues Projects Releases Wiki Activity
267e7e2ff0
glances/docs
History
nicolargo 9c482196f3 Add .redthedocs.yaml configuration file
2024-06-16 22:43:55 +02:00
..
_static Glances version 4.0.0 2024-05-12 10:45:03 +02:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Add .redthedocs.yaml configuration file 2024-06-16 22:43:55 +02:00
dev Replace the wait method by a default timeout on getch 2018-11-25 21:41:00 +01:00
gw Update docs and correct some merge conflicts 2024-03-16 09:23:19 +01:00
man Add .redthedocs.yaml configuration file 2024-06-16 22:43:55 +02:00
api.rst Add .redthedocs.yaml configuration file 2024-06-16 22:43:55 +02:00
build.sh Rebuild docs for #1305 2018-08-16 11:33:25 +02:00
cmds.rst :Merge branch 'develop' into issue2181 2023-12-10 20:12:21 +01:00
conf.py chg: ruff - pyupgrade 2024-05-17 03:37:22 +05:30
config.rst Add support for automatically hiding network interfaces that are down or that don't have any IP addresses #2799 2024-06-01 11:02:58 +02:00
docker.rst [Documentation] Docker compose password unrecognized arguments when applying docs. #2698 2024-03-23 09:39:39 +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 Fix typos and make grammatical and stylistic edits in project documentation 2023-12-10 22:38:38 +04:00
index.rst Fix typos and make grammatical and stylistic edits in project documentation 2023-12-10 22:38:38 +04:00
install.rst Fix typos and make grammatical and stylistic edits in project documentation 2023-12-10 22:38:38 +04:00
make.bat Use Sphinx for doc 2016-03-06 19:16:37 +01:00
Makefile Refactor some code and update docs 2024-04-28 09:21:58 +02:00
objects.inv add intersphinx inventory 2019-06-20 11:46:07 -07:00
quickstart.rst --stdout plugin.attr is not compliant with plugins returning list of dicts #2446 2024-04-24 19:47:57 +02:00
README.txt Update docs 2021-05-26 15:51:43 +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