:tocdepth: 2

.. meta::
    :description lang=en:
        Cloup is an extension pack for the popular Click Python library that adds
        option groups, constraints for group of parameters and the possibility
        to group the subcommands of a MultiCommand in multiple help sections.
    :keywords: python, click, option groups, help sections, mutually exclusive
    :google-site-verification: r5SEmg2wwCURBwKSrL_zQJEJbCVsScFhryur7zdFM3s

.. include:: ../README.rst
    :end-before: docs-home-end


User guide
==========
Please, note that Cloup documentation doesn't replace
`Click documentation <https://click.palletsprojects.com/en/8.0.x/>`_.

.. toctree::
    :caption: User guide
    :maxdepth: 2

    pages/installation
    pages/option-groups
    pages/constraints
    pages/sections
    pages/formatting


.. toctree::
    :caption: API reference
    :hidden:

    autoapi/cloup/index


.. toctree::
    :caption: Project
    :maxdepth: 2
    :hidden:

    GitHub Repository <https://github.com/janluke/cloup>
    Donate <https://www.paypal.com/donate?hosted_button_id=4GTN24HXPMNBJ>
    pages/contributing
    pages/credits
    pages/changelog