.. color-matcher documentation master file, created by
   sphinx-quickstart on Tue Mar  3 20:45:33 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=================
API documentation
=================

.. toctree::
   :maxdepth: 3
   :caption: Contents:

Class hierarchy
---------------

A schematic overview of the class hierarchy is seen in the diagram below:

.. image:: ../../docs/img/arch.png

As the classes will be of primary interest for future extensions, all are documented hereafter.

API
---

.. automodule:: color_matcher
.. autoclass:: ColorMatcher
   :members:
.. autoclass:: HistogramMatcher
   :members:
.. autoclass:: TransferMVGD
   :members:
.. autoclass:: ReinhardMatcher
   :members:
.. autoclass:: MatcherBaseclass
   :members:
..	:inherited-members:

.. Indices and tables
.. ==================
.. 
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`