.. legendkit documentation master file, created by
   sphinx-quickstart on Tue Aug 30 10:48:31 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Legendkit: Legend made easy for matplotlib
==========================================

.. image:: https://raw.githubusercontent.com/Mr-Milk/legendkit/main/images/legendkit-project.svg

When you want to create or adjust the legend in matplotlib,
things can get dirty.
Legendkit may solve your headache.

.. plot:: cover.py
   :include-source: false


Installation
------------

.. code-block:: shell

   pip install legendkit


.. toctree::
   :maxdepth: 1
   :caption: Tutorial
   :hidden:

   tutorial/legend
   tutorial/title&layout
   tutorial/colorbar
   tutorial/layout
   tutorial/matplotlib_legend

.. toctree::
   :maxdepth: 1
   :caption: API
   :hidden:

   api.rst