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, 3 insertions, 0 deletions

diff --git a/diplomacy/utils/splitter.py b/diplomacy/utils/splitter.py
index 5de502e..e1e4169 100644
--- a/diplomacy/utils/splitter.py
+++ b/diplomacy/utils/splitter.py
@@ -24,6 +24,7 @@ class AbstractStringSplitter(metaclass=ABCMeta):
     """ Breaks a string into its components - Generic class """
     def __init__(self, string, length):
         """ Constructor
+
             :param string: the string to split
             :param length: the maximum length of the split
         """
@@ -60,6 +61,7 @@ class OrderSplitter(AbstractStringSplitter):
     """ Splits an order into its components """
     def __init__(self, string):
         """ Constructor
+
             :param string: the string to split
         """
         self._unit_index = None
@@ -196,6 +198,7 @@ class PhaseSplitter(AbstractStringSplitter):
     """ Splits a phase into its components """
     def __init__(self, string):
         """ Constructor
+
             :param string: the string to split
         """
         self._season_index = None