.. PyBERT Developer Guide documentation master file, created by
   sphinx-quickstart on Tue Feb 10 10:04:12 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===========================
 *PyBERT* Developer's Guide
===========================

Note to PyBERT *users*
----------------------

The documentation for the *PyBERT* project has 2 parts:

* help for stand-alone GUI application *users*, and
* help for PyBERT *developers* and *importers*

This is the help for developers and importers.

If you're looking for help with the GUI application, you're in the wrong place.
Instead, try:

* Looking at the *Help* tab of the PyBERT GUI.
* Looking at the `PyBERT FAQ <https://github.com/capn-freako/PyBERT/wiki/pybert_faq>`_.
* Sending me e-mail at: <capn.freako@gmail.com>.

Note to PyBERT *importers*
--------------------------

If you are importing PyBERT functionality into a larger body of work, this *is* the right place for you, since it provides:

- module, class, and attribute definitions and specifications of intent, and
- calling signatures for module/class member functions.

Contents
--------

.. toctree::
   :maxdepth: 2

   intro
   modules
   todo

Indices and tables
------------------

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