doc/docutils/docapi.rst

   1
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3  Documentation of the programming interface (API)
   4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   5
   6 This section describes the python modules of the
   7 ``salome.kernel`` python package. The main part is generated from the
   8 code documentation included in source python files.
   9
  10 :mod:`salome.kernel` -- Package containing the KERNEL python utilities
  11 ======================================================================
  12
  13 :mod:`deprecation` -- Indication of deprecated modules and functions
  14 --------------------------------------------------------------------
  15
  16 .. automodule:: salome.kernel.deprecation
  17    :members:
  18
  19
  20 :mod:`termcolor` -- Display colored text in terminal
  21 ----------------------------------------------------
  22
  23 .. automodule:: salome.kernel.termcolor
  24    :members:
  25    :exclude-members: TEST_termcolor
  26
  27
  28 :mod:`logger` -- Logging utility
  29 --------------------------------
  30
  31 .. automodule:: salome.kernel.logger
  32
  33 .. autoclass:: Logger
  34    :members:
  35    :show-inheritance:
  36
  37 .. autoclass:: ExtLogger
  38    :members:
  39    :show-inheritance:
  40
  41
  42 :mod:`studyedit` -- Study editor
  43 --------------------------------
  44
  45 .. automodule:: salome.kernel.studyedit
  46    :members:
  47
  48
  49 :mod:`varlist` -- Handle Exchange Variables
  50 -------------------------------------------
  51
  52 .. automodule:: salome.kernel.varlist
  53    :members: