.. py-mixins documentation master file, created by
   pypi-sphinx-quickstart.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Quick Start Example documentation!
*********************************************

Mixin classes which may be added to your own classes to add certain functionality to them.

.. toctree::
   :caption: Tutorial

   tutorial
   auto_examples/index


An overview
===========


.. autosummarynameonly::

      mixins.repr.ReprMixin
      mixins.propertycache.SimplePropertyCacheMixin
      mixins.attrequals.EqOnAttrsMixin

Quick Links
------------

Find the source code `on Github <https://github.com/nickderobertis/py-mixins>`_.


mixins
-------------------------------------------------------


This is a simple example:

.. code:: python

    import mixins


.. toctree:: api/modules
   :caption: API Documentation
   :maxdepth: 3

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

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