help_pages.help_section
=======================

.. py:module:: help_pages.help_section

.. autoapi-nested-parse::

   This module contains pydantic classes for help sections.



Classes
-------

.. autoapisummary::

   help_pages.help_section.ValueRenderType
   help_pages.help_section.HelpRow
   help_pages.help_section.HelpSection
   help_pages.help_section.HelpPage


Module Contents
---------------

.. py:class:: ValueRenderType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Determines how the value part of the list is rendered.


   .. py:attribute:: CODE
      :value: 'code'



   .. py:attribute:: PLAIN
      :value: 'plain'



.. py:class:: HelpRow

   A single row in a help section.


   .. py:attribute:: key
      :type:  str | django.utils.safestring.SafeString


   .. py:attribute:: value
      :type:  str | django.utils.safestring.SafeString


   .. py:attribute:: value_render_type
      :type:  ValueRenderType


   .. py:attribute:: hidden
      :type:  bool
      :value: False



   .. py:attribute:: css_id
      :type:  str | django.utils.safestring.SafeString | None
      :value: None



.. py:class:: HelpSection

   Contains a section for the help pages.


   .. py:attribute:: heading
      :type:  str | django.utils.safestring.SafeString


   .. py:attribute:: rows
      :type:  list[HelpRow]


   .. py:attribute:: hidden
      :type:  bool
      :value: False



   .. py:attribute:: css_id
      :type:  str | django.utils.safestring.SafeString | None
      :value: None



.. py:class:: HelpPage

   Contains all variable data for help pages.


   .. py:attribute:: heading
      :type:  str | django.utils.safestring.SafeString


   .. py:attribute:: sections
      :type:  list[HelpSection]