developer.intra2net.com Git - pyi2ncommon/blob - doc/index.rst

   1 .. pyi2ncommon documentation master file, created by
   2    sphinx-quickstart on Fri Jul 24 17:51:25 2015.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Welcome to pyi2ncommon's documentation!
   7 =======================================
   8
   9 This library has two main purposes:
  10   (1) provide an interface to external python code (i.e., code not running
  11       inside a Intra2net system, most notably QA tests) to some of the internal
  12       workings of Intra2net systems. This includes:
  13          - the configuration system (module :py:mod:`pyi2ncommon.cnfvar`)
  14          - interactions with the central daemon (:py:mod:`pyi2ncommon.arnied_api`,
  15            :py:mod:`pyi2ncommon.arnied_wrapper`)
  16          - interactions with the connection daemon (:py:mod:`pyi2ncommon.dial`, :py:mod:`pyi2ncommon.connd_state`)
  17   (2) provide helpers for internal source code, to simplify creating tests or helper scripts in python
  18       that run inside an Intra2net-system. Featuring: :py:mod:`pyi2ncommon.argparse_helpers`,
  19       :py:mod:`pyi2ncommon.buffers`, :py:mod:`pyi2ncommon.iter_helpers`, :py:mod:`pyi2ncommon.log_helpers`,
  20       :py:mod:`pyi2ncommon.log_read`, :py:mod:`pyi2ncommon.text_helpers`
  21
  22 The selection of modules listed here is not complete; modules are not "tied" to one of these two
  23 purposes, most modules can be used inside or outside an Intra2net system.
  24
  25
  26 Contents:
  27
  28 .. toctree::
  29    :maxdepth: 1
  30
  31    license.rst
  32    about_docu.rst
  33    cnfvar-api-ascii-art.rst
  34
  35
  36 Modules
  37 -------
  38 (List may be incomplete, see Module index below for all modules and re-create doc if something is missing)
  39
  40 .. toctree::
  41    modules.rst
  42
  43
  44 Indices and tables
  45 ==================
  46
  47 * :ref:`genindex`
  48 * :ref:`modindex`
  49 * :ref:`search`
  50