Merge branch 'api-doc-improvements'

[pyi2ncommon] / doc / index.rst

.. pyi2ncommon documentation master file, created by
   sphinx-quickstart on Fri Jul 24 17:51:25 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyi2ncommon's documentation!
=======================================

This library has two main purposes:
  (1) provide an interface to external python code (i.e., code not running
      inside a Intra2net system, most notably QA tests) to some of the internal
      workings of Intra2net systems. This includes:
         - the configuration system (module :py:mod:`pyi2ncommon.cnfvar`)
         - interactions with the central daemon (:py:mod:`pyi2ncommon.arnied_api`,
           :py:mod:`pyi2ncommon.arnied_wrapper`)
         - interactions with the connection daemon (:py:mod:`pyi2ncommon.dial`, :py:mod:`pyi2ncommon.connd_state`)
  (2) provide helpers for internal source code, to simplify creating tests or helper scripts in python
      that run inside an Intra2net-system. Featuring: :py:mod:`pyi2ncommon.argparse_helpers`,
      :py:mod:`pyi2ncommon.buffers`, :py:mod:`pyi2ncommon.iter_helpers`, :py:mod:`pyi2ncommon.log_helpers`,
      :py:mod:`pyi2ncommon.log_read`, :py:mod:`pyi2ncommon.text_helpers`

The selection of modules listed here is not complete; modules are not "tied" to one of these two
purposes, most modules can be used inside or outside an Intra2net system.


Contents:

.. toctree::
   :maxdepth: 1

   license.rst
   about_docu.rst
   cnfvar-api-ascii-art.rst

.. toctree::
   :maxdepth: 4

   modules.rst


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`