.. OIOIOI Documentation Index File

OIOIOI Developer's Reference
============================

This is the reference documentation for the OIOIOI Project.

There is also some documentation on the `OIOIOI Project Documentation Site
<http://sio2project.mimuw.edu.pl/display/DOC>`_.

Architecture Overview
---------------------

.. _Django 3.2: https://docs.djangoproject.com/en/3.2/
.. _Django authentication: https://docs.djangoproject.com/en/3.2/topics/auth/
.. _django-registration-redux: https://django-registration-redux.readthedocs.org/en/latest/
.. _Django file storage: https://docs.djangoproject.com/en/3.2/topics/files/
.. _Filetracker: https://github.com/sio2project/filetracker
.. _Sioworkers: https://github.com/sio2project/sioworkers
.. _Celery: https://docs.celeryproject.org/en/latest/index.html
.. _django-pagination: https://code.google.com/p/django-pagination/
.. _pytest: https://docs.pytest.org/
.. _Django i18n: https://docs.djangoproject.com/en/3.2/topics/i18n/
.. _Transifex: https://www.transifex.com/projects/p/sio2project/

The OIOIOI source code is a standard `Django 3.2`_ project, with the following
components used:

* Standard `Django authentication`_
* User registration with `django-registration-redux`_
* :doc:`Modified Django file storage </sections/filestorage>`

  * custom storage class :class:`~oioioi.filetracker.storage.FileTrackerStorage`
  * custom :func:`~oioioi.filetracker.utils.filename_generator` to pass as ``FileField.upload_to``
  * `Filetracker`_

* Distributed judging

  * an :doc:`evaluation manager </sections/evaluation>` running on
    `Celery`_
  * evaluation code running on judging machines is external to OIOIOI (see
    `Sioworkers`_)

* Pagination with `django-pagination`_
* Testing with `pytest`_
* Standard `Django i18n`_ with translations managed by `Transifex`_


Table of Contents
-----------------

.. toctree::
    :maxdepth: 2

    sections/dev
    sections/modules
    sections/filestorage
    sections/scoring
    sections/evaluation
    sections/problem_uploading
    sections/controllers
    sections/notifications
    sections/mixins
    sections/misc
    glossary

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

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