cleanups

Lawouach · Lawouach · commit 66787cdba4f1 · 2013-03-16T22:47:39.000+01:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,13 +1,16 @@
 ws4py - A WebSocket package for Python
 ======================================
 
-Release v\ |version|.
+:Author: `Sylvain Hellegouarch <http://www.defuze.org>`_
+:Release: |version|
+:License: `BSD <https://github.com/Lawouach/WebSocket-for-Python/blob/master/LICENSE>`_
+:Source code: https://github.com/Lawouach/WebSocket-for-Python
 
-ws4py is a Python package implementing the WebSocket protocol as defined in `RFC 6455 <http://tools.ietf.org/html/rfc6455>`_.
 
-It provides client and server implementations alike that using different techniques like threads, micro-threads or event loops.
+ws4py is a Python package implementing the WebSocket protocol as defined in `RFC 6455 <http://tools.ietf.org/html/rfc6455>`_.
 
-ws4py is released under a `BSD <https://github.com/Lawouach/WebSocket-for-Python/blob/master/LICENSE>`_ license.
+It comes with various server and client implementations and runs
+on CPython 2/3, PyPy and Android.
 
 Overview
 ========
diff --git a/docs/sources/install.rst b/docs/sources/install.rst
@@ -6,20 +6,20 @@ Get the code
 
 ws4py is hosted on `github <https://github.com/Lawouach/WebSocket-for-Python>`_ and can be retrieved from there:
 
-.. code-block:: guess
+.. code-block:: console
     
     $ git clone git@github.com:Lawouach/WebSocket-for-Python.git
 
 
 Installing the ws4py package is performed as usual:
 
-.. code-block:: guess
+.. code-block:: console
     
     $ python setup.py install
 
 However, since ws4py is referenced in `PyPI <http://pypi.python.org/pypi/ws4py>`_, it can also be installed through easy_install, distribute or pip:
 
-.. code-block:: guess
+.. code-block:: console
     
     $ pip install ws4py
     $ easy_install ws4py
diff --git a/docs/sources/maintainer/design.rst b/docs/sources/maintainer/design.rst
@@ -45,9 +45,10 @@ Implementation
 
 ws4py data model is rather simple and follows the protocol itself:
 
-a highlevel WebSocket class that determines actions to carry based on messages that are parsed.
-a Stream class that handles a single message at a time
-a Frame class that performs the low level protocol parsing of frames
+- a highlevel :class:`ws4py.websocket.WebSocket` class that determines actions to carry based on messages that are parsed.
+- a :class:`ws4py.streaming.Stream` class that handles a single message at a time
+- a :class:`ws4py.framing.Frame` class that performs the low level protocol parsing of frames
+
 Each are inter-connected as russian dolls generators. The process heavily relies on the capacity to send to a generator. So everytime one of those layers requires something, it yields and then its holder sends it back whatever was required.
 
 The Frame parser yields the number of bytes it needs at any time, the stream parser forwards it back to the WebSocket class which gets data from the underlying data provider it holds a reference to (a socket typically). The WebSocket class sends bytes as they are read from the socket down to the stream parser which forwards them to the frame parser.
