help_pages.help_section

This module contains pydantic classes for help sections.

Classes

ValueRenderType	Determines how the value part of the list is rendered.
HelpRow	A single row in a help section.
HelpSection	Contains a section for the help pages.
HelpPage	Contains all variable data for help pages.

Module Contents

class help_pages.help_section.ValueRenderType(*args, **kwds)

Bases: enum.Enum

Determines how the value part of the list is rendered.

CODE = 'code'

PLAIN = 'plain'

HTML = 'html'

class help_pages.help_section.HelpRow

A single row in a help section.

key: str | django.utils.safestring.SafeString

value: str | django.utils.safestring.SafeString

value_render_type: ValueRenderType

hidden: bool = False

css_id: str | django.utils.safestring.SafeString | None = None

class help_pages.help_section.HelpSection

Contains a section for the help pages.

heading: str | django.utils.safestring.SafeString

rows: list[HelpRow]

hidden: bool = False

css_id: str | django.utils.safestring.SafeString | None = None

class help_pages.help_section.HelpPage

Contains all variable data for help pages.

heading: str | django.utils.safestring.SafeString

sections: list[HelpSection]