aboutsummaryrefslogtreecommitdiffstats
path: root/libpathod
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2012-11-02 14:22:54 +1300
committerAldo Cortesi <aldo@nullcube.com>2012-11-02 14:22:54 +1300
commit791252ac5e26c818397d3b2928300672175d8ce8 (patch)
treedd4c2b8b8c291eef5ed2ed14aa32b66f04523a75 /libpathod
parent3ca3e7c48551e56da61629cd492a16add87f12a0 (diff)
downloadmitmproxy-791252ac5e26c818397d3b2928300672175d8ce8.tar.gz
mitmproxy-791252ac5e26c818397d3b2928300672175d8ce8.tar.bz2
mitmproxy-791252ac5e26c818397d3b2928300672175d8ce8.zip
Examples and documentation.
Diffstat (limited to 'libpathod')
-rw-r--r--libpathod/templates/docs_libpathod.html22
-rw-r--r--libpathod/templates/examples_setup.html4
-rw-r--r--libpathod/templates/index.html22
-rw-r--r--libpathod/templates/libpathod_pathoc.html7
4 files changed, 30 insertions, 25 deletions
diff --git a/libpathod/templates/docs_libpathod.html b/libpathod/templates/docs_libpathod.html
index 8d51ebba..aa404eed 100644
--- a/libpathod/templates/docs_libpathod.html
+++ b/libpathod/templates/docs_libpathod.html
@@ -1,7 +1,27 @@
{% extends "frame.html" %}
{% block body %}
-Foo
+<div class="page-header">
+ <h1>
+ libpathod
+ <small>Using pathod and pathoc in code.</small>
+ </h1>
+</div>
+<div class="row">
+ <div class="span6">
+
+ <p> Behind the pathod and pathoc command-line tools lurks
+ <b>libpathod</b>, a powerful library for manipulating and serving HTTP
+ requests and responses. The canonical documentation for the library is
+ in the code, and can be accessed using pydoc.</p>
+
+ </div>
+ <div class="span6">
+ <h1> pathoc </h1>
+
+ {% include "libpathod_pathoc.html" %}
+ </div>
+</div>
{% endblock %}
diff --git a/libpathod/templates/examples_setup.html b/libpathod/templates/examples_setup.html
index bde45840..b80ad379 100644
--- a/libpathod/templates/examples_setup.html
+++ b/libpathod/templates/examples_setup.html
@@ -3,8 +3,8 @@
<span class="k">class</span> <span class="nc">Test</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
-<span class="sd"> Testing the requests module with </span>
-<span class="sd"> a pathod instance started for </span>
+<span class="sd"> Testing the requests module with</span>
+<span class="sd"> a pathod instance started for</span>
<span class="sd"> each test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
diff --git a/libpathod/templates/index.html b/libpathod/templates/index.html
index 9561fee1..4b52b6a5 100644
--- a/libpathod/templates/index.html
+++ b/libpathod/templates/index.html
@@ -66,26 +66,4 @@
</div>
</div>
-
-<div style="margin-top: 50px" class="row">
- <div class="span6">
- <div>
- <h1> <a href="/docs/test">libpathod.test</a> </h1>
-
- <p>Using pathod in your unit tests.</p>
-
- </div>
- </div>
- <div class="span6">
- <div>
- <h1> <a href="/docs/test">libpathod.test</a> </h1>
-
- <p>Using pathod in your unit tests.</p>
-
- {% include "examples_context.html" %}
-
- </div>
- </div>
-</div>
-
{% endblock %}
diff --git a/libpathod/templates/libpathod_pathoc.html b/libpathod/templates/libpathod_pathoc.html
new file mode 100644
index 00000000..f2737c01
--- /dev/null
+++ b/libpathod/templates/libpathod_pathoc.html
@@ -0,0 +1,7 @@
+<div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
+<span class="kn">from</span> <span class="nn">libpathod</span> <span class="kn">import</span> <span class="n">pathoc</span>
+
+<span class="n">p</span> <span class="o">=</span> <span class="n">pathoc</span><span class="o">.</span><span class="n">Pathoc</span><span class="p">(</span><span class="s">&quot;google.com&quot;</span><span class="p">,</span> <span class="mi">80</span><span class="p">)</span>
+<span class="n">p</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
+<span class="k">print</span> <span class="n">p</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s">&quot;get:/&quot;</span><span class="p">)</span>
+</pre></div>