DOC: update development documentation dd9e5ce

CNAME

@@ -0,0 +1 @@
+robpasmue.github.io/toucan-tournament

version/dev/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 855f5c0eab3798e3e821ec376191a247
+tags: 645f666f9bcd5a90fca523b33c5a78b7

version/dev/_sources/autoapi/index.rst.txt

@@ -0,0 +1,11 @@
+.. _ref_api_reference:
+
+API reference
+=============
+
+This page contains the ``toucan-mvp-calculator`` API reference.
+
+.. toctree::
+   :titlesonly:
+
+   /autoapi/toucan/mvp/calculator/index

version/dev/_sources/autoapi/toucan/mvp/calculator/discipline/index.rst.txt

@@ -0,0 +1,231 @@
+toucan.mvp.calculator.discipline
+================================
+
+.. py:module:: toucan.mvp.calculator.discipline
+
+.. autoapi-nested-parse::
+
+   Module defining the disciplines ran in the Toucan Tournament and auxiliary methods.
+
+   ..
+       !! processed by numpydoc !!
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   toucan.mvp.calculator.discipline.ToucanDiscipline
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   toucan.mvp.calculator.discipline.get_discipline_by_name
+
+
+Module Contents
+---------------
+
+.. py:class:: ToucanDiscipline(*args, **kwds)
+
+   Bases: :py:obj:`enum.Enum`
+
+
+
+   Provides an enum holding the different disciplines available.
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Notes
+
+   The pattern on how to process each line of the files for each
+   discipline match is stored here. The values in each enum are as
+   follows:
+
+   1. Enum ID.
+   2. Regex for processing each player's contribution in a match.
+      Assumed conditions:
+
+       * Name, nickname and team name can be anything.
+       * Match statistics (scores, rebounds etc.) MUST be a number.
+       * Player number MUST be a number.
+       * Player position MUST be a letter.
+
+   3. Dictionary containing the "evaluation" as a function of the position.
+   4. Location in which the points are stored inside the evaluation and whether
+      the points contributed are considered as an addition or subtraction
+      (e.g. goal made or goal received).
+   5. Extra rating points (e.g. initial).
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+   .. py:attribute:: BASKETBALL
+
+
+   .. py:attribute:: HANDBALL
+
+
+   .. py:method:: get_pattern() -> str
+
+      
+      Accessor method to the line pattern in a match file.
+
+
+
+      :Returns:
+
+          :class:`python:str`
+              The regex expression for a match line.
+
+
+
+
+
+
+
+
+
+
+
+
+
+      ..
+          !! processed by numpydoc !!
+
+
+   .. py:method:: get_eval_params() -> Dict[str, Tuple[int]]
+
+      
+      Accessor method to the evaluation parameters for a player in a match file.
+
+
+
+      :Returns:
+
+          :obj:`Dict`\[:class:`python:str`, :obj:`Tuple`\[:class:`python:int`]]
+              Dictionary containing the evaluation parameters as a
+              function of the position.
+
+
+
+
+
+
+
+
+
+
+
+
+
+      ..
+          !! processed by numpydoc !!
+
+
+   .. py:method:: get_points_in_eval_params() -> Tuple[Tuple[int, bool]]
+
+      
+      Accessor method to the positions in the evaluation parameters.
+
+
+
+      :Returns:
+
+          :obj:`Tuple`\[:obj:`Tuple`\[:class:`python:int`, :ref:`bool <python:bltin-boolean-values>`]]
+              Tuple of tuples, where each subtuple indicates the location
+              where points are contributed and whether they should be considered
+              as an addition to the team's score os a subtraction.
+
+
+
+
+
+
+
+
+
+
+
+
+
+      ..
+          !! processed by numpydoc !!
+
+
+   .. py:method:: get_extra_points() -> Dict[str, int]
+
+      
+      Accessor method to the extra rating points for a player in a match file.
+
+
+
+      :Returns:
+
+          :obj:`Dict`\[:class:`python:str`, :class:`python:int`]
+              Dictionary containing the extra rating points as a
+              function of the position.
+
+
+
+
+
+
+
+
+
+
+
+
+
+      ..
+          !! processed by numpydoc !!
+
+
+.. py:function:: get_discipline_by_name(name: str) -> ToucanDiscipline
+
+   
+   Return the ToucanDiscipline enum class corresponding to a given name.
+
+
+   :Parameters:
+
+       **name** : :class:`python:str`
+           The name of the discipline.
+
+   :Returns:
+
+       :obj:`ToucanDiscipline`
+           The ToucanDiscipline enum.
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+

version/dev/_sources/autoapi/toucan/mvp/calculator/errors/index.rst.txt

@@ -0,0 +1,50 @@
+toucan.mvp.calculator.errors
+============================
+
+.. py:module:: toucan.mvp.calculator.errors
+
+.. autoapi-nested-parse::
+
+   Module containing errors to be raised by the Toucan Tournament MVP calculator library.
+
+   ..
+       !! processed by numpydoc !!
+
+
+Exceptions
+----------
+
+.. autoapisummary::
+
+   toucan.mvp.calculator.errors.ToucanException
+
+
+Module Contents
+---------------
+
+.. py:exception:: ToucanException(msg='')
+
+   Bases: :py:obj:`Exception`
+
+
+
+   Specific Toucan exception class.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+

version/dev/_sources/autoapi/toucan/mvp/calculator/index.rst.txt

@@ -0,0 +1,75 @@
+toucan.mvp.calculator
+=====================
+
+.. py:module:: toucan.mvp.calculator
+
+.. autoapi-nested-parse::
+
+
+   Pythonic library used for computing the Most Valuable Player (MVP) of the Toucan Tournament.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   /autoapi/toucan/mvp/calculator/discipline/index
+   /autoapi/toucan/mvp/calculator/errors/index
+   /autoapi/toucan/mvp/calculator/players/index
+   /autoapi/toucan/mvp/calculator/tournament/index
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   toucan.mvp.calculator.__version__
+
+
+Package Contents
+----------------
+
+.. py:data:: __version__
+
+   
+   Toucan MVP calculator library version.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+