
:tocdepth: 3

.. |br| raw:: html

    <div style="min-height:0.1em;"></div>

.. image:: _static/regions_logo_light_path.svg
    :class: only-light index-logo
    :width: 55%
    :align: center
    :alt: Astropy Regions logo

.. image:: _static/regions_logo_dark_path.svg
    :class: only-dark index-logo
    :width: 55%
    :align: center
    :alt: Astropy Regions logo


***************
Astropy Regions
***************

| **Version**: |release|
| **Date**: |today|
| **Useful links**: :doc:`getting_started/install`
    | :ref:`Release Notes <changelog>`

**regions** is an in-development `coordinated package
<https://www.astropy.org/affiliated/index.html#coordinated-packages>`_
of `Astropy`_ for region handling. This package may eventually be merged
into the Astropy core package.


.. admonition:: Important

    If you use Regions for a project that leads to a publication,
    whether directly or as a dependency of another package, please
    include an :ref:`acknowledgment and/or citation <citation>`.

|br|


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

    getting_started/index
    user_guide/index
    reference/index
    development/index
    Release Notes <release_notes/index>


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

    .. grid-item-card:: Getting Started
        :link: getting_started/index
        :link-type: doc
        :text-align: center

        New to Regions? Check out the getting started guides. They
        contain an overview of Regions and an introduction to its main
        concepts.

    .. grid-item-card:: User Guide
        :link: user_guide/index
        :link-type: doc
        :text-align: center

        The user guide provides in-depth information on the key concepts
        of Regions with useful background information and explanation.

    .. grid-item-card:: API Reference Guide
        :link: reference/index
        :link-type: doc
        :text-align: center

        The reference guide contains a detailed description of the
        functions, modules, and objects included in Regions. It assumes
        that you have an understanding of the key concepts.
