update documentation and theme

5 files changed, 45 insertions, 10 deletions

diff --git a/docs/conf.py b/docs/conf.py
index d031524..864bbcf 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -113,8 +113,8 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'classic'
-
+# html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
diff --git a/docs/index.rst b/docs/index.rst
index 80569bc..6c9d065 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,13 +1,17 @@
 Welcome to EventMQ's documentation!
 ===================================
 
+:doc:`protocol`
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
-   
+
+   jobmanager
    receiver
    router
+   sender
 
 
 Indices and tables
diff --git a/docs/protocol.rst b/docs/protocol.rst
index 48dcacc..ea01cf3 100644
--- a/docs/protocol.rst
+++ b/docs/protocol.rst
@@ -54,7 +54,7 @@ FRAME  Value          Description
 ====== ============== ===========
 0      _EMPTY_        leave empty
 1      eMQP/1.0       Protocol version
-2      READY          Command
+2      READY          command
 3      _MSGID_        A unique id for the msg
 4      _QUEUE_NAME_   the name of the queue the worker belongs to
 5      _HEADERS_      dictionary of headers. can be an empty set
@@ -70,9 +70,9 @@ FRAME   Value         Description
 ====== ============== ===========
 0      _EMPTY_        leave empty
 1      eMQP/1.0       Protocol version
-2      INFORM        
+2      INFORM         command
 3      _MSGID_        A unique id for the msg
-4      _QUEUE_NAME_   the name of the queue the worker belongs to
+4      _QUEUE_NAME_   csv seperated names of queue the worker belongs to
 ====== ============== ===========
 
 A **READY** frame consists of a 4-frame multipart message, formatted as follows.
@@ -82,7 +82,7 @@ FRAME  Value          Description
 ====== ============== ===========
 0      _EMPTY_        leave empty
 1      eMQP/1.0       Protocol version
-2      READY         
+2      READY          command
 3      _MSGID_        A unique id for the msg
 ====== ============== ===========
 
@@ -93,7 +93,37 @@ FRAME  Value          Description
 ====== ============== ===========
 0      _EMPTY_        leave empty
 1      eMQP/1.0       Protocol version
-2      REPLY         
+2      REPLY          command
 3      _MSGID_        A unique id for the msg
 4      _MSG_          The reply to respond with
 ====== ============== ===========
+
+A **HEARTBEAT** frame consists of a
+
+====== ============== ===========
+FRAME  Value          Description
+====== ============== ===========
+0      _EMPTY_        leave empty
+1      eMQP/1.0       Protocol version
+2      HEARTBEAT      command
+3      _MSGID_        A unique id for the msg
+====== ============== ===========
+
+A **DISCONNECT** frame consists of
+
+====== ============== ===========
+FRAME  Value          Description
+====== ============== ===========
+0      _EMPTY_        leave empty
+1      eMQP/1.0       Protocol version
+2      DISCONNECT     command
+3      _MSGID_        A unique id for the msg
+====== ============== ===========
+
+Heartbeating
+------------
+ * HEARTBEAT commands are valid at any time after an INFORM command
+ * Any command except DISCONNECT act as a heartbeat. Peers SHOULD NOT send HEARTBEAT commands while sending other commands.
+ * Both worker and broker MUST send heartbeats at regular and agreed-upon intervals.
+ * If the worker detects that the broker disconnected it SHOULD restart the conversation.
+ * If the broker detects that a worker has disconnected it should stop sending it a message of any type.
diff --git a/docs/receiver.rst b/docs/receiver.rst
index 1b61f63..854349c 100644
--- a/docs/receiver.rst
+++ b/docs/receiver.rst
@@ -1,3 +1,3 @@
-.. automodule:: receiver
+.. automodule:: eventmq.receiver
    :members:
    :special-members:
diff --git a/docs/router.rst b/docs/router.rst
index 8e17e12..9f7f576 100644
--- a/docs/router.rst
+++ b/docs/router.rst
@@ -1,2 +1,3 @@
-.. automodule:: router
+.. automodule:: eventmq.router
    :members:
+   :special-members: