Image Transformer documentation
===============================

Welcome to Image Transformer's Documentation.

Please for an up to date documentation refer to the project's `GitHub page <https://github.com/raideno/image-transformer>`_..

.. list-table:: Examples
   :widths: 50 50
   :header-rows: 1

   * - Orignal Image
     - Transformed Image
   * - .. image:: ../data/mona-lisa.png
     - .. image:: ../data/mona-lisa.svg
   * - .. image:: ../data/testing-image.jpg
     - .. image:: ../data/testing-image.svg

Troubleshooting
---------------

If you encounter any issues during installation, please refer to the project's README file or open an issue on the project's `GitHub page <https://github.com/raideno/image-transformer>`_.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation.rst
   quickstart-cli.rst
   quickstart-program.rst
   
.. toctree::
   :maxdepth: 2
   :caption: Examples

   example-1.rst
   example-2.rst

.. toctree::
   :maxdepth: 2
   :caption: Contents

   image_transformer.image_processors
   image_transformer.output_builders
   image_transformer.pixels_processors
   image_transformer.utils