.. oscar documentation master file, created by
   sphinx-quickstart on Fri Dec  9 14:12:42 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to OSCaR's documentation!
=========================================================

OSCaR (the Open Source Colony-assessment Resource) is a python package for
data-driven optimisation of breeding strategies.

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

   getting_started
   developer_setup
   api_index