summaryrefslogtreecommitdiff
path: root/mail/docs/api/mail.rst
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2014-08-25 21:03:17 -0500
committerKali Kaneko <kali@leap.se>2014-08-25 21:03:17 -0500
commit8ad0a200050a51ff52b7db5aabeb6d65b34cf3ee (patch)
treeaa51031ded91c1afbd514ff06c336ebba5e205ff /mail/docs/api/mail.rst
parent0bb58fd37cea2bf77408ee89b8df2489d60eab90 (diff)
sphinx documentation for the mail library
Diffstat (limited to 'mail/docs/api/mail.rst')
-rw-r--r--mail/docs/api/mail.rst70
1 files changed, 70 insertions, 0 deletions
diff --git a/mail/docs/api/mail.rst b/mail/docs/api/mail.rst
new file mode 100644
index 00000000..27132078
--- /dev/null
+++ b/mail/docs/api/mail.rst
@@ -0,0 +1,70 @@
+mail package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+
+ mail.imap
+ mail.smtp
+
+Submodules
+----------
+
+mail.decorators module
+----------------------
+
+.. automodule:: mail.decorators
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.load_tests module
+----------------------
+
+.. automodule:: mail.load_tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.messageflow module
+-----------------------
+
+.. automodule:: mail.messageflow
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.size module
+----------------
+
+.. automodule:: mail.size
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.utils module
+-----------------
+
+.. automodule:: mail.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.walk module
+----------------
+
+.. automodule:: mail.walk
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: mail
+ :members:
+ :undoc-members:
+ :show-inheritance: