.. PattooShared documentation master file, created by
   sphinx-quickstart on Tue Oct 22 22:22:31 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PattooShared
============

The PattooShared ``pip`` module creates a universal set of classes to produce and consume ``pattoo`` compatible data.

Visit the `PattooShared site <https://github.com/PalisadoesFoundation/pattoo-shared>`_ to see the code.

Introduction
------------

General information about the project, including the the prerequisite steps to get it operational on your system.

.. toctree::
   :maxdepth: 2
   :caption: Introduction:

   about
   contributing

Daemons
-------

General information about agents and the classes used to process data in this package.

.. toctree::
   :maxdepth: 2
   :caption: Package Classes:

   daemons

Agents
------

General information about agents and the classes used to process data in this package.

.. toctree::
   :maxdepth: 2
   :caption: Package Classes:

   class_descriptions
   agents

Miscellaneous Information
-------------------------

Technical background information on the project.

.. toctree::
   :maxdepth: 2
   :caption: Miscellaneous Information:

   troubleshooting
   glossary

Developers
----------

.. toctree::
   :maxdepth: 2
   :caption: Developers:

   contributing