Merge pull request #65 from jodal/doc-build-improvements

Doc build improvements

.gitignore

@@ -2,3 +2,4 @@ build
 *.egg-info
 *.pyc
 .tox
+docs/_build/

docs/conf.py

@@ -16,7 +16,8 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join(
+    os.path.dirname(__file__), '..')))
 
 # -- General configuration -----------------------------------------------------
 

ws4py/framing.py

@@ -23,6 +23,7 @@ def __init__(self, opcode=None, body='', masking_key=None, fin=0, rsv1=0, rsv2=0
 
         .. code-block:: python
            :linenos:
+
            >>> test_mask = 'XXXXXX' # perhaps from os.urandom(4)
            >>> f = Frame(OPCODE_TEXT, 'hello world', masking_key=test_mask, fin=1) 
            >>> bytes = f.build()

ws4py/server/cherrypyserver.py

@@ -298,8 +298,8 @@ def handle(self, ws_handler, peer_addr):
         """
         Tracks the provided handler.
 
-        @param ws_handler: websocket handler instance
-        @param peer_addr: remote peer address for tracing purpose
+        :param ws_handler: websocket handler instance
+        :param peer_addr: remote peer address for tracing purpose
         """
         cherrypy.log("Managing WebSocket connection from %s:%d" % (peer_addr[0], peer_addr[1]))
         th = threading.Thread(target=ws_handler.run, name="WebSocket client at %s:%d" % (peer_addr[0], peer_addr[1]))
@@ -340,9 +340,9 @@ def broadcast(self, message, binary=False):
         Broadcasts a message to all connected clients known to
         the server.
 
-        @param message: a message suitable to pass to the send() method
+        :param message: a message suitable to pass to the send() method
           of the connected handler.
-        @param binary: whether or not the message is a binary one
+        :param binary: whether or not the message is a binary one
         """
         for ws_handler in self.pool:
             try:

ws4py/server/geventserver.py

@@ -18,7 +18,7 @@ class UpgradableWSGIHandler(gevent.pywsgi.WSGIHandler):
     If an HTTP request comes in that includes the Upgrade header, it will add
     to the environment two items:
     
-    ``upgrade.protocol` `
+    ``upgrade.protocol``
       The protocol to upgrade to. Checking for this lets you know the request
       wants to be upgraded and the WSGI server supports this interface.