.. title:: Matplotlib documentation

.. module:: matplotlib


##################################
Matplotlib |release| documentation
##################################


Matplotlib is a comprehensive library for creating static, animated,
and interactive visualizations.

Install
=======

.. include:: install/quick_install.inc.rst

.. toctree::
    :hidden:

    install/index

Learn
=====

.. grid:: 1 1 2 2

    .. grid-item-card::
        :padding: 2
        :columns: 6

        **How to use Matplotlib?**
        ^^^
        .. toctree::
            :maxdepth: 1

            users/explain/quick_start
            User guide <users/index.rst>
            tutorials/index.rst
            users/faq.rst

    .. grid-item-card::
        :padding: 2
        :columns: 6

        **What can Matplotlib do?**
        ^^^
        .. toctree::
            :maxdepth: 1

            plot_types/index.rst
            gallery/index.rst


    .. grid-item-card::
        :padding: 2
        :columns: 12

        **Reference**
        ^^^

        .. grid:: 1 1 2 2
            :class-row: sd-align-minor-center

            .. grid-item::

                .. toctree::
                    :maxdepth: 1

                    API reference <api/index>
                    Figure methods <api/figure_api>
                    Plotting methods <api/axes_api>


            .. grid-item::

                Top-level interfaces to create:

                - figures: `.pyplot.figure`
                - subplots: `.pyplot.subplots`, `.pyplot.subplot_mosaic`

Community
=========

.. grid:: 1 1 2 2
    :class-row: sd-align-minor-center

    .. grid-item::

        .. rst-class:: section-toc
        .. toctree::
            :maxdepth: 2

            users/resources/index.rst

    .. grid-item::

        :octicon:`link-external;1em;sd-text-info` `Third-party packages <https://matplotlib.org/mpl-third-party/>`_,

        provide custom, domain specific, and experimental features, including
        styles, colors, more plot types and backends, and alternative
        interfaces.

What's new
==========

.. grid:: 1 1 2 2

    .. grid-item::

       Learn about new features and API changes.

    .. grid-item::

        .. toctree::
            :maxdepth: 1

            users/release_notes.rst


Contribute
==========

.. grid:: 1 1 2 2
    :class-row: sd-align-minor-center

    .. grid-item::

        Matplotlib is a community project maintained for and by its users. See
        :ref:`developers-guide-index` for the many ways you can help!

    .. grid-item::
        .. rst-class:: section-toc
        .. toctree::
            :maxdepth: 2

            devel/index.rst

About us
========

.. grid:: 1 1 2 2
    :class-row: sd-align-minor-center

    .. grid-item::

        Matplotlib was created by neurobiologist John Hunter to work with EEG
        data. It grew to be used and developed by many people in many
        different fields. John's goal was that Matplotlib make easy things easy
        and hard things possible.

    .. grid-item::
        .. rst-class:: section-toc
        .. toctree::
            :maxdepth: 2

            project/index.rst
