.. OpenTamPy documentation master file, created by
   sphinx-quickstart on Mon Jun  7 10:51:04 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to OpenTamPy's documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Table of Contents:

   introduction
   api
   async

**Features:**

- Coverage of full timetable access
- Easily fetch all of your absences and exams
- Provides high-level access to the timetable data structure and absence structure for easy-to-read code!
- Provides high-level access to classmate data and teacher data
- Async support

**Getting Started**

- **Quickstart** :doc:`introduction`
- **Code examples** `Some code examples can be found on Github <https://github.com/neonfighter28/OpenTamPy/tree/master/examples>`_

**API Reference**

- **API Reference** :doc:`api`

.. note:: This project is still in development. Methods may change without any notice in upcoming versions without any guarantee of preserving functionality

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

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