Using Sphinx-Gallery
====================

This section contains what you need to know to use and configure basic aspects
of Sphinx-Gallery.

.. toctree::
   :hidden:

   getting_started
   syntax
   configuration
   projects_list

.. grid:: 1 1 2 2
    :gutter: 2 3 4 4

    .. grid-item-card::
        :text-align: center

        **Getting started**
        ^^^

        Learn the basics of Sphinx-Gallery and set up your project by following a
        step-by-step guide.

        +++

        .. button-ref:: getting_started
            :ref-type: doc
            :expand:
            :color: secondary
            :click-parent:

            Getting Started with Sphinx-Gallery

    .. grid-item-card::
        :text-align: center

        **Write gallery pages**
        ^^^

        Learn the structure and syntax of the Python files that are the input
        for the gallery pages.

        +++

        .. button-ref:: syntax
            :ref-type: doc
            :expand:
            :color: secondary
            :click-parent:

            Structuring Python scripts for Sphinx-Gallery

    .. grid-item-card::
        :text-align: center

        **Customize**
        ^^^

        Adapt Sphinx-Gallery to your needs through the configuration settings.

        +++

        .. button-ref:: configuration
            :ref-type: doc
            :expand:
            :color: secondary
            :click-parent:

            Configuration

    .. grid-item-card::
        :text-align: center

        **Who uses Sphinx-Gallery**
        ^^^

        See how Sphinx-Gallery is used in existing projects.

        +++

        .. button-ref:: projects_list
            :ref-type: doc
            :expand:
            :color: secondary
            :click-parent:

            List of projects using Sphinx-Gallery
