.. _reference-homepage:

Ingredient Parser documentation
================================

The Ingredient Parser package is a Python package for parsing information from recipe ingredient sentences.

.. figure:: /_static/logos/logo_wide.png
  :alt: Ingredient parser banner logo

.. grid:: 1 2 2 4

   .. grid-item-card::
      :text-align: center
      :padding: 3 1 2 1
      :margin: 1 1 0 0

      :material-regular:`directions_run;2em;sd-color-secondary`

      Getting Started
      ^^^^^^^^^^^^^^^
      Getting started and basic usage.
      +++
      .. button-ref:: tutorials/index
                  :expand:
                  :color: secondary
                  :click-parent:

                  Getting Started


   .. grid-item-card::
      :text-align: center
      :padding: 3 1 2 1
      :margin: 1 1 0 0

      :material-regular:`import_contacts;2em;sd-color-secondary`

      How To
      ^^^^^^
      How to achieve specific goals.
      +++
      .. button-ref:: how-to/index
                  :expand:
                  :color: secondary
                  :click-parent:

                  How To


   .. grid-item-card::
      :text-align: center
      :padding: 3 1 2 1
      :margin: 1 1 0 0

      :material-regular:`school;2em;sd-color-secondary`

      Explanation
      ^^^^^^^^^^^
      The details of how this library works.
      +++
      .. button-ref:: explanation/index
                  :expand:
                  :color: secondary
                  :click-parent:

                  Explanation


   .. grid-item-card::
      :text-align: center
      :padding: 3 1 2 1
      :margin: 1 1 0 0

      :material-regular:`code;2em;sd-color-secondary`

      API Reference
      ^^^^^^^^^^^^^
      Reference documentation.
      +++
      .. button-ref:: reference/index
                  :expand:
                  :color: secondary
                  :click-parent:

                  API Reference

.. toctree::
   :maxdepth: 1
   :hidden:

   Getting Started <tutorials/index>
   How To Guides <how-to/index>
   Explanation <explanation/index>
   API Reference <reference/index>
   Resources <resources/index>
   changelog