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, 4 insertions, 2 deletions

diff --git a/diplomacy/utils/strings.py b/diplomacy/utils/strings.py
index 65efb64..80b83a3 100644
--- a/diplomacy/utils/strings.py
+++ b/diplomacy/utils/strings.py
@@ -63,6 +63,7 @@ DUMMY = 'dummy'
 DUMMY_PLAYER = 'dummy_player'
 DUMMY_POWERS = 'dummy_powers'
 ERROR = 'error'
+ERROR_TYPE = 'error_type'
 FOR_OMNISCIENCE = 'for_omniscience'
 FORCED = 'forced'
 FORCED_ORDERS = 'forced_orders'
@@ -235,8 +236,9 @@ def role_is_special(role):
 
 def switch_special_role(role):
     """ Return opposite special role of given special role:
-        - observer role if omniscient role is given
-        - omniscient role if observer role is given
+
+            - observer role if omniscient role is given
+            - omniscient role if observer role is given
     """
     if role == OBSERVER_TYPE:
         return OMNISCIENT_TYPE