sphinx: Add sphinx docstring

[sid.git] / doc / source / doc.rst

diff --git a/doc/source/doc.rst b/doc/source/doc.rst
new file mode 100644 (file)
index 0000000..ad9ffa9
--- /dev/null
+++ b/doc/source/doc.rst
@@ -0,0 +1,24 @@
+Documentation
+==============
+
+The Bot
+-------
+
+.. autoclass:: sid.sid.MUCBot
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. user autodecorator:: with sphinx v2.0
+.. autofunction:: sid.sid.botcmd(hidden, name)
+
+Plugin base
+-----------
+
+The plugin class to derive from.
+
+.. autoclass:: sid.plugin.Plugin
+    :members:
+    :undoc-members:
+
+.. vim: spell spelllang=en