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>

25 files changed, 169 insertions, 0 deletions

diff --git a/docs/api/diplomacy.client.channel.rst b/docs/api/diplomacy.client.channel.rst
new file mode 100644
index 0000000..053544c
--- /dev/null
+++ b/docs/api/diplomacy.client.channel.rst
@@ -0,0 +1,6 @@
+diplomacy.client.channel
+========================
+
+.. automodule:: diplomacy.client.channel
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.client.connection.rst b/docs/api/diplomacy.client.connection.rst
new file mode 100644
index 0000000..9909466
--- /dev/null
+++ b/docs/api/diplomacy.client.connection.rst
@@ -0,0 +1,7 @@
+diplomacy.client.connection
+===========================
+
+.. automodule:: diplomacy.client.connection
+   :members:
+   :show-inheritance:
+   :exclude-members: send, write_request
diff --git a/docs/api/diplomacy.client.network_game.rst b/docs/api/diplomacy.client.network_game.rst
new file mode 100644
index 0000000..80093dd
--- /dev/null
+++ b/docs/api/diplomacy.client.network_game.rst
@@ -0,0 +1,6 @@
+diplomacy.client.network\_game
+==============================
+
+.. automodule:: diplomacy.client.network_game
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.client.rst b/docs/api/diplomacy.client.rst
new file mode 100644
index 0000000..660b82c
--- /dev/null
+++ b/docs/api/diplomacy.client.rst
@@ -0,0 +1,9 @@
+diplomacy.client
+================
+
+.. toctree::
+   :maxdepth: -1
+
+   diplomacy.client.channel
+   diplomacy.client.connection
+   diplomacy.client.network_game
diff --git a/docs/api/diplomacy.communication.notifications.rst b/docs/api/diplomacy.communication.notifications.rst
new file mode 100644
index 0000000..337035b
--- /dev/null
+++ b/docs/api/diplomacy.communication.notifications.rst
@@ -0,0 +1,6 @@
+diplomacy.communication.notifications
+=====================================
+
+.. automodule:: diplomacy.communication.notifications
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.communication.requests.rst b/docs/api/diplomacy.communication.requests.rst
new file mode 100644
index 0000000..b0ff08e
--- /dev/null
+++ b/docs/api/diplomacy.communication.requests.rst
@@ -0,0 +1,6 @@
+diplomacy.communication.requests
+================================
+
+.. automodule:: diplomacy.communication.requests
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.communication.responses.rst b/docs/api/diplomacy.communication.responses.rst
new file mode 100644
index 0000000..b34dfef
--- /dev/null
+++ b/docs/api/diplomacy.communication.responses.rst
@@ -0,0 +1,6 @@
+diplomacy.communication.responses
+=================================
+
+.. automodule:: diplomacy.communication.responses
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.communication.rst b/docs/api/diplomacy.communication.rst
new file mode 100644
index 0000000..90aa07a
--- /dev/null
+++ b/docs/api/diplomacy.communication.rst
@@ -0,0 +1,9 @@
+diplomacy.communication
+=======================
+
+.. toctree::
+   :maxdepth: -1
+
+   diplomacy.communication.notifications
+   diplomacy.communication.requests
+   diplomacy.communication.responses
diff --git a/docs/api/diplomacy.daide.notifications.rst b/docs/api/diplomacy.daide.notifications.rst
new file mode 100644
index 0000000..1c5251b
--- /dev/null
+++ b/docs/api/diplomacy.daide.notifications.rst
@@ -0,0 +1,6 @@
+diplomacy.daide.notifications
+=============================
+
+.. automodule:: diplomacy.daide.notifications
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.daide.requests.rst b/docs/api/diplomacy.daide.requests.rst
new file mode 100644
index 0000000..86782be
--- /dev/null
+++ b/docs/api/diplomacy.daide.requests.rst
@@ -0,0 +1,6 @@
+diplomacy.daide.requests
+========================
+
+.. automodule:: diplomacy.daide.requests
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.daide.responses.rst b/docs/api/diplomacy.daide.responses.rst
new file mode 100644
index 0000000..b8d46d0
--- /dev/null
+++ b/docs/api/diplomacy.daide.responses.rst
@@ -0,0 +1,6 @@
+diplomacy.daide.responses
+=========================
+
+.. automodule:: diplomacy.daide.responses
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.daide.rst b/docs/api/diplomacy.daide.rst
new file mode 100644
index 0000000..ff8a23d
--- /dev/null
+++ b/docs/api/diplomacy.daide.rst
@@ -0,0 +1,9 @@
+diplomacy.daide
+===============
+
+.. toctree::
+   :maxdepth: -1
+
+   diplomacy.daide.notifications
+   diplomacy.daide.requests
+   diplomacy.daide.responses
diff --git a/docs/api/diplomacy.engine.game.rst b/docs/api/diplomacy.engine.game.rst
new file mode 100644
index 0000000..c6bcb05
--- /dev/null
+++ b/docs/api/diplomacy.engine.game.rst
@@ -0,0 +1,6 @@
+diplomacy.engine.game
+=====================
+
+.. automodule:: diplomacy.engine.game
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.engine.map.rst b/docs/api/diplomacy.engine.map.rst
new file mode 100644
index 0000000..4f5514d
--- /dev/null
+++ b/docs/api/diplomacy.engine.map.rst
@@ -0,0 +1,6 @@
+diplomacy.engine.map
+====================
+
+.. automodule:: diplomacy.engine.map
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.engine.message.rst b/docs/api/diplomacy.engine.message.rst
new file mode 100644
index 0000000..98f8a25
--- /dev/null
+++ b/docs/api/diplomacy.engine.message.rst
@@ -0,0 +1,6 @@
+diplomacy.engine.message
+========================
+
+.. automodule:: diplomacy.engine.message
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.engine.power.rst b/docs/api/diplomacy.engine.power.rst
new file mode 100644
index 0000000..655c231
--- /dev/null
+++ b/docs/api/diplomacy.engine.power.rst
@@ -0,0 +1,6 @@
+diplomacy.engine.power
+======================
+
+.. automodule:: diplomacy.engine.power
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.engine.renderer.rst b/docs/api/diplomacy.engine.renderer.rst
new file mode 100644
index 0000000..c150229
--- /dev/null
+++ b/docs/api/diplomacy.engine.renderer.rst
@@ -0,0 +1,6 @@
+diplomacy.engine.renderer
+=========================
+
+.. automodule:: diplomacy.engine.renderer
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.engine.rst b/docs/api/diplomacy.engine.rst
new file mode 100644
index 0000000..4fc098f
--- /dev/null
+++ b/docs/api/diplomacy.engine.rst
@@ -0,0 +1,11 @@
+diplomacy.engine
+================
+
+.. toctree::
+   :maxdepth: -1
+
+   diplomacy.engine.game
+   diplomacy.engine.map
+   diplomacy.engine.message
+   diplomacy.engine.power
+   diplomacy.engine.renderer
diff --git a/docs/api/diplomacy.integration.rst b/docs/api/diplomacy.integration.rst
new file mode 100644
index 0000000..2625bb6
--- /dev/null
+++ b/docs/api/diplomacy.integration.rst
@@ -0,0 +1,6 @@
+diplomacy.integration
+=====================
+
+.. toctree::
+
+    diplomacy.integration.webdiplomacy_net.api
diff --git a/docs/api/diplomacy.integration.webdiplomacy_net.api.rst b/docs/api/diplomacy.integration.webdiplomacy_net.api.rst
new file mode 100644
index 0000000..8478615
--- /dev/null
+++ b/docs/api/diplomacy.integration.webdiplomacy_net.api.rst
@@ -0,0 +1,6 @@
+integration.webdiplomacy\_net.api
+=================================
+
+.. automodule:: diplomacy.integration.webdiplomacy_net.api
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.utils.errors.rst b/docs/api/diplomacy.utils.errors.rst
new file mode 100644
index 0000000..82fd9ee
--- /dev/null
+++ b/docs/api/diplomacy.utils.errors.rst
@@ -0,0 +1,6 @@
+diplomacy.utils.errors
+======================
+
+.. automodule:: diplomacy.utils.errors
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.utils.exceptions.rst b/docs/api/diplomacy.utils.exceptions.rst
new file mode 100644
index 0000000..e948ed4
--- /dev/null
+++ b/docs/api/diplomacy.utils.exceptions.rst
@@ -0,0 +1,6 @@
+diplomacy.utils.exceptions
+==========================
+
+.. automodule:: diplomacy.utils.exceptions
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.utils.export.rst b/docs/api/diplomacy.utils.export.rst
new file mode 100644
index 0000000..afbb9d6
--- /dev/null
+++ b/docs/api/diplomacy.utils.export.rst
@@ -0,0 +1,6 @@
+diplomacy.utils.export
+======================
+
+.. automodule:: diplomacy.utils.export
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.utils.order_results.rst b/docs/api/diplomacy.utils.order_results.rst
new file mode 100644
index 0000000..98bee71
--- /dev/null
+++ b/docs/api/diplomacy.utils.order_results.rst
@@ -0,0 +1,6 @@
+diplomacy.utils.order\_results
+==============================
+
+.. automodule:: diplomacy.utils.order_results
+   :members:
+   :show-inheritance:
diff --git a/docs/api/diplomacy.utils.rst b/docs/api/diplomacy.utils.rst
new file mode 100644
index 0000000..2e775ef
--- /dev/null
+++ b/docs/api/diplomacy.utils.rst
@@ -0,0 +1,10 @@
+diplomacy.utils
+===============
+
+.. toctree::
+   :maxdepth: -1
+
+   diplomacy.utils.errors
+   diplomacy.utils.exceptions
+   diplomacy.utils.export
+   diplomacy.utils.order_results