mirror
/
glances
mirror of https://github.com/nicolargo/glances.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update API docs

This commit is contained in:
nicolargo 2025-08-17 18:34:31 +02:00
parent 06c6f8408e
commit 973dd8978e
5 changed files with 650 additions and 12767 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12676
docs/api/python.rst
View File

File diff suppressed because it is too large Load Diff

721
docs/api/restful.rst
View File

File diff suppressed because it is too large Load Diff

2
docs/man/glances.1
View File

@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GLANCES" "1" "Aug 10, 2025" "4.4.0_dev1" "Glances"
.TH "GLANCES" "1" "Aug 17, 2025" "4.4.0_dev1" "Glances"
.SH NAME
glances \- An eye on your system
.SH SYNOPSIS

9
glances/__init__.py
View File

@ -188,12 +188,3 @@ def main():
# Glances can be ran in standalone, client or server mode
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())
start(config=core.get_config(), args=core.get_args())

9
glances/outputs/glances_stdout_api_doc.py
View File

@ -54,6 +54,7 @@ def print_tldr(gl):
print('')
print('.. code-block:: python')
print('')
printtab('>>> gl.network.keys()')
printtab(f'{gl.network.keys()}')
printtab(f'>>> gl.network["{gl.network.keys()[0]}"]')
printtab(f'{pformat(gl.network[gl.network.keys()[0]])}')
@ -85,7 +86,6 @@ def print_plugins_list(gl):
print('')
printtab('>>> gl.plugins()')
printtab(f'{gl.plugins()}')
print('```')
print('')
@ -102,8 +102,8 @@ def print_plugin(gl, plugin):
print('')
print('.. code-block:: python')
print('')
printtab(f'>>> gl.{plugin}')
printtab(f'Return a {type(stats_obj)} object')
printtab(f'>>> type(gl.{plugin})')
printtab(f'{type(stats_obj)}')
if len(stats_obj.keys()) > 0 and isinstance(stats_obj[stats_obj.keys()[0]], dict):
printtab(f'>>> gl.{plugin}')
printtab(f'Return a dict of dict with key=<{stats_obj[stats_obj.keys()[0]]["key"]}>')
@ -139,7 +139,7 @@ def print_plugin(gl, plugin):
def print_plugins(gl):
"""Print the details of all plugins."""
for plugin in gl.plugins():
for plugin in [p for p in gl.plugins() if p not in ['programlist']]:
print_plugin(gl, plugin)
@ -155,7 +155,6 @@ class GlancesStdoutApiDoc:
def update(self, stats, duration=1):
"""Display issue"""
# Display header
print(APIDOC_HEADER)