Added ReadtheDocs documentation for the public API

- Reformatted the docstring to be compatible
- Added tests to make sure the documentation compiles properly
- Added sphinx as a pip requirement

Co-authored-by: Philip Paquette <pcpaquette@gmail.com>
Co-authored-by: notoraptor <stevenbocco@gmail.com>

1 files changed, 8 insertions, 5 deletions

diff --git a/diplomacy/utils/scheduler_event.py b/diplomacy/utils/scheduler_event.py
index 1d097d8..8eaf0ff 100644
--- a/diplomacy/utils/scheduler_event.py
+++ b/diplomacy/utils/scheduler_event.py
@@ -19,12 +19,15 @@
 from diplomacy.utils.jsonable import Jsonable
 
 class SchedulerEvent(Jsonable):
-    """ Scheduler event class. Properties:
-        - time_unit: unit time (in seconds) used by scheduler (time between 2 tasks checkings).
+    """ Scheduler event class.
+
+        Properties:
+
+        - **time_unit**: unit time (in seconds) used by scheduler (time between 2 tasks checkings).
           Currently 1 second in server scheduler.
-        - time_added: scheduler time (nb. time units) when data was added to scheduler.
-        - delay: scheduler time (nb. time units) to wait before processing time.
-        - current_time: current scheduler time (nb. time units).
+        - **time_added**: scheduler time (nb. time units) when data was added to scheduler.
+        - **delay**: scheduler time (nb. time units) to wait before processing time.
+        - **current_time**: current scheduler time (nb. time units).
     """
     __slots__ = ['time_unit', 'time_added', 'delay', 'current_time']
     model = {