Doc tweaks.

This commit is contained in:
Aldo Cortesi 2012-07-30 21:12:42 +12:00
parent fde65270af
commit 158106d346
5 changed files with 60 additions and 41 deletions

View File

@ -1,41 +1,47 @@
{% extends "frame.html" %} {% extends "frame.html" %}
{% block body %} {% block body %}
<div class="page-header"> <section>
<h1> <div class="page-header">
where <h1>
<small>to get the code.</small> where
</h1> <small>to get the code.</small>
</div> </h1>
</div>
<h3>git clone git://github.com/cortesi/pathod.git</h3> <h3>git clone git://github.com/cortesi/pathod.git</h3>
<p>Please use the <a href="http://github.com/cortesi/pathod/issues">github <p>Please use the <a href="http://github.com/cortesi/pathod/issues">github
issue tracker</a> to report bugs. </p> issue tracker</a> to report bugs. </p>
</section>
<div class="page-header"> <section>
<h1> <div class="page-header">
why <h1>
<small>this was written.</small> why
</h1> <small>this was written.</small>
</div> </h1>
</div>
<p>I started pathod to improve testing for for the <a <p>I started pathod to improve testing for for the <a
href="http://mitmproxy.org">mitmproxy</a> project. From there, it soon grew href="http://mitmproxy.org">mitmproxy</a> project. From there, it soon grew
into quite a versatile HTTP Swiss army knife.</p> into quite a versatile HTTP Swiss army knife.</p>
</section>
<div class="page-header"> <section>
<h1> <div class="page-header">
who <h1>
<small>is to blame.</small> who
</h1> <small>is to blame.</small>
</div> </h1>
</div>
<p>pathod is developed by me, <a href="http://corte.si">Aldo Cortesi</a>. <p>pathod is developed by me, <a href="http://corte.si">Aldo Cortesi</a>.
Email me at aldo@corte.si with feedback or suggestions. If you like pathod, you Email me at aldo@corte.si with feedback or suggestions. If you like pathod, you
should follow me on <a href="http://twitter.com/cortesi">twitter</a> and <a should follow me on <a href="http://twitter.com/cortesi">twitter</a> and <a
href="http://corte.si">subscribe to my blog</a>.</p> href="http://corte.si">subscribe to my blog</a>.</p>
</section>
{% endblock %} {% endblock %}

View File

@ -7,7 +7,21 @@
</h1> </h1>
</div> </div>
pathoc hostname get:"/foo/bar":h"foo"="bar" get:/wah:b@1m
pathoc --ssl hostname get:"/foo/bar":h"foo"="bar" get:"/wah":b@1m <section>
<div class="page-header">
<h1>Getting Started</h1>
</div>
</section>
<section>
<div class="page-header">
<h1>Basic Fuzzing</h1>
</div>
</section>
{% endblock %} {% endblock %}

View File

@ -13,7 +13,7 @@ conceivable HTTP response, including ones that creatively violate the
standards. HTTP responses are specified using a <a href="/docs/language">small, standards. HTTP responses are specified using a <a href="/docs/language">small,
terse language</a>, which pathod shares with its evil twin pathoc. </p> terse language</a>, which pathod shares with its evil twin pathoc. </p>
<section id="api"> <section>
<div class="page-header"> <div class="page-header">
<h1>Getting started</h1> <h1>Getting started</h1>
</div> </div>
@ -45,7 +45,7 @@ those, use the command-line help:</p>
</section> </section>
<section id="api"> <section>
<div class="page-header"> <div class="page-header">
<h1>Anchors</h1> <h1>Anchors</h1>
</div> </div>
@ -63,7 +63,7 @@ the "=" is a response specifier.</p>
</section> </section>
<section id="files"> <section>
<div class="page-header"> <div class="page-header">
<h1>File Access</h1> <h1>File Access</h1>
</div> </div>
@ -96,7 +96,7 @@ disabled if no directory is specified:</p>
</section> </section>
<section id="api"> <section>
<div class="page-header"> <div class="page-header">
<h1>API</h1> <h1>API</h1>
</div> </div>

View File

@ -19,7 +19,7 @@
<p> The canonical docs can be accessed using pydoc: </p> <p> The canonical docs can be accessed using pydoc: </p>
<pre class="terminal">pydoc libpathod.testing</pre> <pre class="terminal">pydoc libpathod.test</pre>
<p> The remainder of this page demonstrates some common interaction <p> The remainder of this page demonstrates some common interaction
patterns using <a patterns using <a

View File

@ -12,10 +12,9 @@
</div> </div>
</div> </div>
<br>
<div class="row"> <div class="row">
<div class="span6"> <div class="span6">
<div class="well"> <div>
<h1> <a href="/docs/pathod">pathod</a> </h1> <h1> <a href="/docs/pathod">pathod</a> </h1>
<p>A pathological web daemon.</p> <p>A pathological web daemon.</p>
@ -24,7 +23,7 @@
</div> </div>
</div> </div>
<div class="span6"> <div class="span6">
<div class="well"> <div>
<h1> <a href="/docs/pathoc">pathoc</a> </h1> <h1> <a href="/docs/pathoc">pathoc</a> </h1>
<p>A perverse HTTP client.</p> <p>A perverse HTTP client.</p>
@ -36,9 +35,9 @@
</div> </div>
<div class="row"> <div style="margin-top: 50px" class="row">
<div class="span6"> <div class="span6">
<div class="well"> <div>
<h1>pathod server</h1> <h1>pathod server</h1>
<p>A live, public instance of pathod</p> <p>A live, public instance of pathod</p>
@ -67,7 +66,7 @@
</div> </div>
</div> </div>
<div class="span6"> <div class="span6">
<div class="well"> <div>
<h1> <a href="/docs/test">libpathod.test</a> </h1> <h1> <a href="/docs/test">libpathod.test</a> </h1>
<p>Using pathod in your unit tests.</p> <p>Using pathod in your unit tests.</p>