.. include:: ../README.rst

.. grid:: 1 1 1 2
    :gutter: 2

    .. grid-item-card::  Getting Started
        :text-align: center
        :img-top: figures/index_getting_started.svg
        :img-alt: getting started image

        Handling and installation instructions.

        .. button-ref:: getting_started/index
            :expand:
            :color: secondary
            :click-parent:

    .. grid-item-card::  User Guide
        :text-align: center
        :img-top: figures/index_user_guide.svg
        :img-alt: User guide image

        Detailed user guide for Qblox products.

        .. button-ref:: cluster/index
            :expand:
            :color: secondary
            :click-parent:

    .. grid-item-card::  Tutorials
        :text-align: center
        :img-top: figures/material_school.svg
        :img-alt: Tutorials image

        Tutorials for Q1ASM and Quantify.

        .. button-ref:: tutorials/index
            :expand:
            :color: secondary
            :click-parent:

    .. grid-item-card:: Application Examples
        :text-align: center
        :img-top: figures/index_contribute.svg
        :img-alt: Application examples image

        In depth examples for specific applications, ready for use.

        .. button-ref:: applications/index
            :expand:
            :color: secondary
            :click-parent:
    
    .. grid-item-card:: API Reference
        :text-align: center
        :img-top: figures/index_api.svg
        :img-alt: API reference image

        A detailed description of the functions, modules, and objects included in
        the `qblox_instruments` software package.

        .. button-ref:: api_reference/index
            :expand:
            :color: secondary
            :click-parent:

.. toctree::
    :maxdepth: 1
    :caption: Contents
    :name: contents
    :hidden:

    getting_started/index
    cluster/index
    tutorials/index
    applications/index
    api_reference/index


#######
Indices
#######

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