From b71e2f6f2bbc3ecaa1e463bae0cc6fd4762c6b8a Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Sun, 24 Jun 2012 11:14:54 +1200
Subject: [PATCH] More doc refinement.

---
 doc-src/index.html  |  9 ++---
 doc-src/pathoc.html |  8 +++-
 doc-src/pathod.html | 96 +++++++++++++++++++++------------------------
 doc-src/test.html   | 11 +++---
 libpathod/app.py    |  8 ++--
 5 files changed, 64 insertions(+), 68 deletions(-)

diff --git a/doc-src/index.html b/doc-src/index.html
index acd389f94..30405375b 100644
--- a/doc-src/index.html
+++ b/doc-src/index.html
@@ -1,4 +1,3 @@
-
 <div class="hero-unit">
 <h1>Tools for testing and torturing HTTP clients, servers and proxies.</h1>
 </div>
@@ -6,7 +5,7 @@
 <div class="row">
     <div class="span4">
         <div class="well">
-            <h1> pathod </h1>
+            <h1> <a href="@!top!@/pathod.html">pathod</a> </h1>
 
             A pathological web daemon.
 
@@ -14,7 +13,7 @@
     </div>
     <div class="span4">
         <div class="well">
-            <h1> pathoc </h1>
+            <h1> <a href="@!top!@/pathoc.html">pathoc</a> </h1>
 
             A perverse HTTP client.
 
@@ -22,9 +21,9 @@
     </div>
     <div class="span4">
         <div class="well">
-            <h1> libpathod.test </h1>
+            <h1> <a href="@!top!@/test.html">libpathod.test</a> </h1>
 
-            Use pathod and pathoc in your unit tests.
+            Using pathod and pathoc in your unit tests.
 
         </div>
     </div>
diff --git a/doc-src/pathoc.html b/doc-src/pathoc.html
index fe11ed3f9..38b153e71 100644
--- a/doc-src/pathoc.html
+++ b/doc-src/pathoc.html
@@ -1,5 +1,9 @@
-
-Test.
+<div class="page-header">
+   <h1>
+        pathoc
+        <small>A perverse HTTP client.</small>
+    </h1>
+</div>
 
 
 
diff --git a/doc-src/pathod.html b/doc-src/pathod.html
index 01cfca307..6cb287347 100644
--- a/doc-src/pathod.html
+++ b/doc-src/pathod.html
@@ -1,6 +1,11 @@
-# pathod
+<div class="page-header">
+   <h1>
+        pathod
+        <small>A pathological web daemon.</small>
+    </h1>
+</div>
 
-At __pathod__'s heart is a tiny, terse language for crafting HTTP responses,
+At __pathod__'s heart is a small, terse language for crafting HTTP responses,
 designed to be easy to specify in a request URL.  The simplest way to use
 __pathod__ is to fire up the daemon, and specify the response behaviour you
 want using this language in the request URL.  Here's a minimal example:
@@ -284,55 +289,42 @@ Supported data types are:
 __pathod__ exposes a simple API, intended to make it possible to drive and
 inspect the daemon remotely for use in unit testing and the like. 
 
-### /api/log
 
-Returns the current log buffer. At the moment the buffer size is 500 entries -
-when the log grows larger than this, older entries are discarded. The returned
-data is a JSON dictionary, with the form:
-    
-    {
-        'logs': [ ENTRIES ]
-    }
+<table class="table table-bordered table-condensed">
+    <tbody >
+        <tr>
+            <td>
+                /api/clear_log
+            </td>
+            <td>
+                A POST to this URL clears the log buffer.
+            </td>
+        </tr>
+        <tr>
+            <td>
+                /api/info
+            </td>
+            <td>
+                Basic version and configuration info.
+            </td>
+        </tr>
+        <tr>
+            <td>
+                /api/log
+            </td>
+            <td>
+                Returns the current log buffer. At the moment the buffer size is 500 entries -
+                when the log grows larger than this, older entries are discarded. The returned
+                data is a JSON dictionary, with the form:
 
-Where each entry looks like this:
-
-    {
-        # Record of actions taken at specified byte offsets
-        'actions': [(200, 'disconnect'), (10, 'pause', 1)],
-        # HTTP return code
-        'code': 200,
-        # Request duration in seconds
-        'duration': 0.00020599365234375,
-        # ID unique to this invocation of pathod
-        'id': 2,
-        # The request that triggered the response
-        'request': {
-            'full_url': 'http://testing:9999/p/200:b@1000:p1,10:d200',
-            'headers': {
-                'Accept': '*/*',
-                'Host': 'localhost:9999',
-                'User-Agent': 'curl/7.21.4'
-            },
-            'host': 'localhost:9999',
-            'method': 'POST',
-            'path': '/p/200:b@1000:p1,10:d200',
-            'protocol': 'http',
-            'query': '',
-            'remote_address': ('10.0.0.234', 63448),
-            'uri': '/p/200:b@1000:p1,10:d200',
-            'version': 'HTTP/1.1'
-        },
-        # The response spec that was served. You can re-parse this to get full
-        # details on the response.
-        'spec': '200:b@1000:p1,10:d200',
-        # Time at which response startd.
-        'started': 1335735586.469218
-    }
-
-You can preview the JSON data returned for a log entry through the built-in web
-interface.
-
-
-### /api/log/clear
-
-A POST to this URL clears the log buffer.
+                <pre>
+                    {
+                        'log': [ ENTRIES ]
+                    }
+                </pre>
+                You can preview the JSON data returned for a log entry through the built-in web
+                interface.
+            </td>
+        </tr>
+    </tbody>
+</table>
diff --git a/doc-src/test.html b/doc-src/test.html
index fe11ed3f9..045b1f78e 100644
--- a/doc-src/test.html
+++ b/doc-src/test.html
@@ -1,5 +1,6 @@
-
-Test.
-
-
-
+<div class="page-header">
+   <h1>
+        libpathod.test
+        <small>Using pathod and pathoc in your unit tests.</small>
+    </h1>
+</div>
diff --git a/libpathod/app.py b/libpathod/app.py
index f7c307726..406325a10 100644
--- a/libpathod/app.py
+++ b/libpathod/app.py
@@ -15,13 +15,13 @@ def api_info():
 @app.route('/api/log')
 def api_log():
     return jsonify(
-        log = app.config["pathod"].get_log() 
+        log = app.config["pathod"].get_log()
     )
 
 
 @app.route('/api/clear_log')
 def api_clear_log():
-    app.config["pathod"].clear_log() 
+    app.config["pathod"].clear_log()
     return "OK"
 
 
@@ -34,12 +34,12 @@ def index():
 @app.route('/help')
 def help():
     return render_template("help.html", section="help")
-    
+
 
 @app.route('/log')
 def log():
     return render_template("log.html", section="log", log=app.config["pathod"].get_log())
-    
+
 
 @app.route('/log/<int:lid>')
 def onelog(lid):