.. Setler Project documentation master file, created by
   sphinx-quickstart on Sun Apr 16 22:58:53 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Settler Project's documentation!
===========================================

This project is a version of the Settlers "Catan" game written in Python for the team15 Software Engineering Project. The game itself is turn based similar in parts to monopoly but mainly more focused on resources and building roads across the world map. For a detailed explanation of the game rules and concepts please refer to this: https://www.catan.com/understand-catan/game-rules document.

Documentation
-------------


.. toctree::
   :maxdepth: 2

   installation
   classes
   tests
   class_diagram


* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`