iommi
=====

.. include:: README.rst
    :start-line: 4




Finding your way around
=======================

These docs are split by what you need right now:

- **Tutorials** are lessons to work through when you're new. Start here.
- **How-to guides** answer "how do I ...?" when you have a job to do.
- **Reference** is the dry description of every knob iommi has.
- **Explanation** covers the thinking behind iommi, so your code comes out idiomatic.


.. toctree::
   :maxdepth: 2
   :caption: Tutorials

   getting_started
   tutorial

.. toctree::
   :maxdepth: 2
   :caption: How-to guides

   cookbook

.. toctree::
   :maxdepth: 2
   :caption: Reference

   api
   common_config
   views
   dev_tools

.. toctree::
   :maxdepth: 2
   :caption: Explanation

   components
   understanding

.. toctree::
   :maxdepth: 1
   :caption: About the project

   imports
   history
   authors
   contributing

   @github <https://github.com/iommirocks/iommi>
   @discord <https://discord.gg/ZyYRYhf7Pd>
   @pypi <https://pypi.org/project/iommi/>




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

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