.. iterchain documentation master file, created by
   sphinx-quickstart on Tue Apr  2 17:24:39 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 2



.. mdinclude:: ../README.md


|

API
---

.. automodule:: iterchain

|

Generators
``````````

.. automodule:: iterchain.generators
    :members:


Iterators
``````````

.. autofunction:: iterchain.chainable

.. autoclass:: iterchain.Iterator
    :members:
    :undoc-members:


|
|

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

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