aboutsummaryrefslogtreecommitdiffstats
path: root/docs/scripting/api.rst
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2016-10-12 10:57:05 +1300
committerAldo Cortesi <aldo@nullcube.com>2016-10-16 20:26:06 +1300
commitfdb6a44245249a50b5c95cdf0d8d13ecddfe5726 (patch)
treee173229b7b604641b8a103995e3ceb64276abf3c /docs/scripting/api.rst
parent26af9b29fc3fed60a003d097b3470e85115b2161 (diff)
downloadmitmproxy-fdb6a44245249a50b5c95cdf0d8d13ecddfe5726.tar.gz
mitmproxy-fdb6a44245249a50b5c95cdf0d8d13ecddfe5726.tar.bz2
mitmproxy-fdb6a44245249a50b5c95cdf0d8d13ecddfe5726.zip
docs: cleanups improvements and fighting sphinx
- Hide links to internal code listings, and link to github instead - Improve formatting of code/example captions - Fix outdated documentation of command-line options - Complete documentation of all events + improved formatting - tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion
Diffstat (limited to 'docs/scripting/api.rst')
-rw-r--r--docs/scripting/api.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/scripting/api.rst b/docs/scripting/api.rst
new file mode 100644
index 00000000..03d35920
--- /dev/null
+++ b/docs/scripting/api.rst
@@ -0,0 +1,8 @@
+.. _api:
+
+API
+====
+
+.. automodule:: mitmproxy.models.http
+ :inherited-members:
+ :members: HTTPFlow, HTTPRequest, HTTPResponse