From: Jeremy Stanley <fungi@yuggoth.org>
Date: Mon, 30 Apr 2018 19:34:24 +0000 (+0000)
Subject: Basic API documentation
X-Git-Url: https://mudpy.org/gitweb?p=mudpy.git;a=commitdiff_plain;h=98c3e62c49e6bedfdac7d0db3184ce7ce71233c9

Basic API documentation

Add a stub page to generate autodoc-based API documentation for use
with Sphinx.
---

diff --git a/doc/source/api.rst b/doc/source/api.rst
new file mode 100644
index 0000000..1d4f9e3
--- /dev/null
+++ b/doc/source/api.rst
@@ -0,0 +1,54 @@
+mudpy package
+=============
+
+Submodules
+----------
+
+mudpy\.daemon module
+--------------------
+
+.. automodule:: mudpy.daemon
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+mudpy\.data module
+------------------
+
+.. automodule:: mudpy.data
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+mudpy\.misc module
+------------------
+
+.. automodule:: mudpy.misc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+mudpy\.password module
+----------------------
+
+.. automodule:: mudpy.password
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+mudpy\.telnet module
+--------------------
+
+.. automodule:: mudpy.telnet
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: mudpy
+    :members:
+    :undoc-members:
+    :show-inheritance: