Documentation
=============

**imgLP**

----

**A library that provides tools for image processing.**

.. code-block:: text

   Author        : Lancelot PINCET
   Library       : imgLP
   GitHub        : https://github.com/LancelotPincet/imgLP
   HTTPS         : https://github.com/LancelotPincet/imgLP.git
   SSH           : git@github.com:LancelotPincet/imgLP.git
   PyPI          : https://pypi.org/project/imgLP
   Docs          : https://imgLP.readthedocs.io

**imgLP** is a library written by **Lancelot PINCET**.
The source code can be consulted on its `GitHub repository <https://github.com/LancelotPincet/imgLP>`_.
However for simply using the features, you can install it in your Python environment using `pip <https://pypi.org/project/imgLP>`_.
And for information, do not hesitate to consult the `documentation <https://imgLP.readthedocs.io>`_.

1. New to **imgLP**? Check out the :doc:`Beginner Guide <beginner_guide>` to get up and running.
2. Want a deeper understanding of key concepts in **imgLP**? Dive into the :doc:`User Guide <user_guide>` to get an in-depth understanding of the tool.
3. Have a doubt on a syntax in **imgLP**? Consult the :doc:`Reference Guide <reference_guide>` to have detailed information on how to call the objects. 

.. toctree::
   :maxdepth: 1
   :caption: Beginner guide

   what_is
   install
   quicky

.. toctree::
   :maxdepth: 1
   :caption: User guide

   concepts
   features
   tutorials

.. toctree::
   :maxdepth: 1
   :caption: Reference guide

   modules
   scripts