.. DonatelloPyzza documentation master file, created by
   sphinx-quickstart on Mon Apr 10 12:20:40 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. figure:: ../images/turtle.png
   :alt: Texte alternatif
   :target: http://blog.flozz.fr/
   :width: 400px
   :align: center

An Educational Game to Learn Algorithmic
==========================================

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

**DonatelloPyzza is a simple and educational game** to help beginners **learn algorithmic and Python from high school to university**. 
A turtle can move through a grid and touch each cell until it finds the pizza.
The objective is to **build the most efficient algorithm to find the pizza with the least amount of movement** in a large 
number of maze configurations. To do this, you have access to a **simple game interface** allowing you to move your 
turtle and retrieve a feedback after each action.

This game can be used by several kind of learners:

- **for young beginners**: they can hard-code a path to help the turtle find its pizza in small predefined mazes.

- **for beginners**: they can develop intuitive heuristics to find the pizza in automatically generated mazes.

- **for intermediate or advanced developers**: they can develop a complex path finding method or AI-based solutions and assess their solution automatically on a high number of automatically generated mazes.

DonatelloPyzza is a Free Software distributed under the CC BY-NC-SA 4.0 license. 
You are welcome to use, remix, transform, and build upon the material as long as you do not use it for a commercial purpose and you use the same license for your material. 

This documentation will help you to make good use of this game. Please report any documentation issues, including typos or unclear elements. 

You are welcome to join us on the github repository of DonatelloPyzza!



.. toctree::
   :maxdepth: 2
   :caption: The basics

   ./gettingStarted.rst

.. toctree::
   :maxdepth: 2
   :caption: Tutorials

   ./tutorials.rst

.. toctree::
   :maxdepth: 2
   :caption: User manual

   ./userManual.rst

.. toctree::
   :maxdepth: 2
   :caption: Links

   ./links.rst