Autodocs for CheckProxyRequest

praekeltfoundation · Feb 8, 2016 · 51da97b · 51da97b
1 parent 3911edf
commit 51da97b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 14 deletions.
diff --git a/docs/http-proxy.rst b/docs/http-proxy.rst
@@ -1,18 +1,15 @@
 vumi-http-proxy Package
-================
+=======================
+
+
 
-:mod: `vumi-http-proxy` Package
---------------------
 
-.. automodule:: vumi-http-proxy.__init__
-	:members:
-    :undoc-members:
-    :show-inheritance:
 
-:mod: `http_proxy` Module
----------------------------
+.. py:module:: vumi_http_proxy.http_proxy
 
-.. automodule:: vumi-http-proxy.http_proxy
+
+
+.. autoclass:: CheckProxyRequest
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,7 @@ Contents:
    queen-of-ni.rst
    http-proxy.rst
 
-.. automodule:: vumi-http-proxy.http_proxy
+.. automodule:: vumi-http-proxy
 	:members:
 
 

diff --git a/vumi_http_proxy/http_proxy.py b/vumi_http_proxy/http_proxy.py
@@ -105,10 +105,12 @@ def __init__(self, blacklist, resolver, http_client):
 
 
 class Initialize(object):
-    """This class initialises the proxy based on the configuration specified
+    """
+    This class initialises the proxy based on the configuration specified
     """
     def __init__(self, blacklist, dnsservers, ip, port):
-        """ :param blacklist: List of disallowed ip addresses.
+        """
+        :param blacklist: List of disallowed ip addresses.
         :type blacklist: list
         :param dnservers: List of manual dns servers to use.
         :type dnsservers: list