Files
glances/docs
nicolargo cbed074842 feat(v5): add short_name renderer hint (v4 parity)
Plugins can declare an optional short_name in fields_description for
compact label display in tight per-plugin renderers:

  ctx_switches.short_name = 'ctx_sw'
  soft_interrupts.short_name = 'sw_int'
  interrupts.short_name = 'inter'

A new field_label(schema, field_name, prefer_short=False) helper
encapsulates the resolution order:
  - prefer_short=True: short_name -> label -> field name
  - prefer_short=False (default, generic renderer): label -> field name

The cpu render_curses_v5 now pulls every column label via
field_label(..., prefer_short=True) instead of hardcoding labels.

Mirrors v4 short_name (cf. curse_add_stat in plugins/plugin/model.py).
Documented in architecture decisions section 3.2 and SKILL-plugin.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 16:07:10 +02:00
..
2026-04-19 09:36:25 +02:00
2026-05-05 08:52:20 +02:00
2026-05-05 08:52:20 +02:00
2026-05-05 08:52:20 +02: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