.. JobShopLib documentation master file, created by
   sphinx-quickstart on Sun Jul  7 16:51:14 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to JobShopLib's documentation!
======================================

**Version:** |version|

.. image:: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png
   :target: https://github.com/Pabloo22/job_shop_lib
   :width: 24px
   :alt: GitHub
   :align: right

JobShopLib is a Python package for creating, solving, and visualizing
Job Shop Scheduling Problems (JSSP).

It follows a modular design, allowing users to easily extend the library
with new solvers, dispatching rules, visualization functions, etc.

See
`this <https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing>`__
Google Colab notebook for a quick start guide!

Contents
--------

.. toctree::
    :maxdepth: 3

    install
    tutorial
    examples
    api

Indices and tables
==================

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