[tor-commits] [bridgedb/develop] Fix Sphinx documentation for bridgedb.email package and add extra docs.
isis at torproject.org
isis at torproject.org
Thu Aug 28 11:55:14 UTC 2014
commit bad57a94208a5cf8c3a099503fe57d5cb6a882c2
Author: Isis Lovecruft <isis at torproject.org>
Date: Thu Aug 28 09:39:20 2014 +0000
Fix Sphinx documentation for bridgedb.email package and add extra docs.
---
doc/sphinx/source/bridgedb.email.autoresponder.rst | 8 ------
doc/sphinx/source/bridgedb.email.dkim.rst | 8 ------
doc/sphinx/source/bridgedb.email.request.rst | 8 ------
doc/sphinx/source/bridgedb.email.rst | 14 ++++++++++
doc/sphinx/source/bridgedb.email.server.rst | 8 ------
doc/sphinx/source/bridgedb.email.templates.rst | 8 ------
doc/sphinx/source/bridgedb.rst | 5 ----
lib/bridgedb/email/autoresponder.py | 20 +++++++++++++-
lib/bridgedb/email/dkim.py | 16 ++++++++++-
lib/bridgedb/email/request.py | 16 +++++++++++
lib/bridgedb/email/server.py | 29 +++++++++++++++++++-
lib/bridgedb/email/templates.py | 10 ++++++-
12 files changed, 101 insertions(+), 49 deletions(-)
diff --git a/doc/sphinx/source/bridgedb.email.autoresponder.rst b/doc/sphinx/source/bridgedb.email.autoresponder.rst
deleted file mode 100644
index 90be549..0000000
--- a/doc/sphinx/source/bridgedb.email.autoresponder.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-bridgedb.email.autoresponder
-----------------------------
-
-.. automodule:: bridgedb.email.autoresponder
- :members:
- :undoc-members:
- :private-members:
- :show-inheritance:
diff --git a/doc/sphinx/source/bridgedb.email.dkim.rst b/doc/sphinx/source/bridgedb.email.dkim.rst
deleted file mode 100644
index 6c1b5c4..0000000
--- a/doc/sphinx/source/bridgedb.email.dkim.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-bridgedb.email.dkim
--------------------
-
-.. automodule:: bridgedb.email.dkim
- :members:
- :undoc-members:
- :private-members:
- :show-inheritance:
diff --git a/doc/sphinx/source/bridgedb.email.request.rst b/doc/sphinx/source/bridgedb.email.request.rst
deleted file mode 100644
index 48638bc..0000000
--- a/doc/sphinx/source/bridgedb.email.request.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-bridgedb.email.request
-----------------------
-
-.. automodule:: bridgedb.email.request
- :members:
- :undoc-members:
- :private-members:
- :show-inheritance:
diff --git a/doc/sphinx/source/bridgedb.email.rst b/doc/sphinx/source/bridgedb.email.rst
new file mode 100644
index 0000000..ba9b4a9
--- /dev/null
+++ b/doc/sphinx/source/bridgedb.email.rst
@@ -0,0 +1,14 @@
+.. _email-pkg:
+
+bridgedb.email
+--------------
+
+.. contents:: bridgedb.email
+ :depth: 3
+
+.. automodule:: bridgedb.email.__init__
+.. automodule:: bridgedb.email.autoresponder
+.. automodule:: bridgedb.email.dkim
+.. automodule:: bridgedb.email.request
+.. automodule:: bridgedb.email.server
+.. automodule:: bridgedb.email.templates
diff --git a/doc/sphinx/source/bridgedb.email.server.rst b/doc/sphinx/source/bridgedb.email.server.rst
deleted file mode 100644
index b2d59fb..0000000
--- a/doc/sphinx/source/bridgedb.email.server.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-bridgedb.email.server
----------------------
-
-.. automodule:: bridgedb.email.server
- :members:
- :undoc-members:
- :private-members:
- :show-inheritance:
diff --git a/doc/sphinx/source/bridgedb.email.templates.rst b/doc/sphinx/source/bridgedb.email.templates.rst
deleted file mode 100644
index e7f2a58..0000000
--- a/doc/sphinx/source/bridgedb.email.templates.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-bridgedb.email.templates
-------------------------
-
-.. automodule:: bridgedb.email.templates
- :members:
- :undoc-members:
- :private-members:
- :show-inheritance:
diff --git a/doc/sphinx/source/bridgedb.rst b/doc/sphinx/source/bridgedb.rst
index 0e7c188..912cb72 100644
--- a/doc/sphinx/source/bridgedb.rst
+++ b/doc/sphinx/source/bridgedb.rst
@@ -14,11 +14,6 @@ BridgeDB Package and Module Documentation
bridgedb.crypto
bridgedb.Dist
bridgedb.email
- bridgedb.email.autoresponder
- bridgedb.email.dkim
- bridgedb.email.request
- bridgedb.email.server
- bridgedb.email.templates
bridgedb.Filters
bridgedb.HTTPServer
bridgedb.interfaces
diff --git a/lib/bridgedb/email/autoresponder.py b/lib/bridgedb/email/autoresponder.py
index 06b37a5..aea8cae 100644
--- a/lib/bridgedb/email/autoresponder.py
+++ b/lib/bridgedb/email/autoresponder.py
@@ -12,7 +12,25 @@
# :license: see LICENSE for licensing information
#_____________________________________________________________________________
-"""Functionality for autoresponding to incoming emails."""
+"""Functionality for autoresponding to incoming emails.
+
+.. py:module:: bridgedb.email.autoresponder
+ :synopsis: Functionality for autoresponding to incoming emails.
+
+bridgedb.email.autoresponder
+============================
+
+::
+
+ bridgedb.email.autoresponder
+ | |_ createResponseBody - Parse lines from an incoming email and determine
+ | | how to respond.
+ | |_ generateResponse - Create an email response.
+ |
+ |_ EmailResponse - Holds information for generating a response to a request.
+ |_ SMTPAutoresponder - An SMTP autoresponder for incoming mail.
+..
+"""
from __future__ import unicode_literals
from __future__ import print_function
diff --git a/lib/bridgedb/email/dkim.py b/lib/bridgedb/email/dkim.py
index 311a03a..9abcf3f 100644
--- a/lib/bridgedb/email/dkim.py
+++ b/lib/bridgedb/email/dkim.py
@@ -12,7 +12,21 @@
# :license: see LICENSE for licensing information
#_____________________________________________________________________________
-"""Functions for checking DKIM verification results in email headers."""
+"""Functions for checking DKIM verification results in email headers.
+
+.. py:module:: bridgedb.email.dkim
+ :synopsis: Functions for checking DKIM verification results in email
+ headers.
+
+bridgedb.email.dkim
+===================
+
+::
+
+ bridgedb.email.dkim
+ |_ checkDKIM - Check the DKIM verification results header.
+..
+"""
from __future__ import unicode_literals
diff --git a/lib/bridgedb/email/request.py b/lib/bridgedb/email/request.py
index a6326fe..7a6e7cc 100644
--- a/lib/bridgedb/email/request.py
+++ b/lib/bridgedb/email/request.py
@@ -14,6 +14,22 @@
"""Classes for parsing and storing information about requests for bridges
which are sent to the email distributor.
+
+.. py:module:: bridgedb.email.request
+ :synopsis: Classes for parsing and storing information about requests for
+ bridges which are sent to the email distributor.
+
+bridgedb.email.request
+======================
+
+::
+
+ bridgedb.email.request
+ | |_ determineBridgeRequestOptions - Figure out which filters to apply, or
+ | offer help.
+ |_ EmailBridgeRequest - A request for bridges which was received through
+ the email distributor.
+..
"""
from __future__ import print_function
diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py
index 66362e2..625849d 100644
--- a/lib/bridgedb/email/server.py
+++ b/lib/bridgedb/email/server.py
@@ -13,7 +13,34 @@
#_____________________________________________________________________________
-"""Servers which interface with clients and distribute bridges over SMTP."""
+"""Servers which interface with clients and distribute bridges over SMTP.
+
+.. py:module:: bridgedb.email.server
+ :synopsis: Servers which interface with clients and distribute bridges
+ over SMTP.
+
+bridgedb.email.server
+=====================
+
+::
+
+ bridgedb.email.server
+ | |_ addServer - Set up a SMTP server which listens on the configured
+ | EMAIL_PORT for incoming connections, and responds as
+ | necessary to requests for bridges.
+ |
+ |_ MailServerContext - Helper object that holds information used by the
+ | email subsystem.
+ |_ SMTPMessage - Plugs into Twisted Mail and receives an incoming message.
+ |_ SMTPIncomingDelivery - Plugs into SMTPIncomingServerFactory and handles
+ | SMTP commands for incoming connections.
+ |_ SMTPIncomingDeliveryFactory - Factory for SMTPIncomingDeliverys.
+ |_ SMTPIncomingServerFactory - Plugs into twisted.mail.smtp.SMTPFactory;
+ creates a new SMTPMessageDelivery, which
+ handles response email automation, whenever
+ we get a incoming connection on the SMTP port.
+..
+"""
from __future__ import unicode_literals
diff --git a/lib/bridgedb/email/templates.py b/lib/bridgedb/email/templates.py
index eb5c528..5eb97fb 100644
--- a/lib/bridgedb/email/templates.py
+++ b/lib/bridgedb/email/templates.py
@@ -10,7 +10,15 @@
# :license: see LICENSE for licensing information
#_____________________________________________________________________________
-"""Templates for formatting emails sent out by the email distributor."""
+"""Templates for formatting emails sent out by the email distributor.
+
+.. py:module:: bridgedb.email.templates
+ :synopsis: Templates for formatting emails sent out by the email
+ distributor.
+
+bridgedb.email.templates
+========================
+"""
from __future__ import print_function
from __future__ import unicode_literals
More information about the tor-commits
mailing list