aboutsummaryrefslogtreecommitdiffstats
path: root/docs/dev
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/dev
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/dev')
-rw-r--r--docs/dev/models.rst81
1 files changed, 0 insertions, 81 deletions
diff --git a/docs/dev/models.rst b/docs/dev/models.rst
deleted file mode 100644
index a333fb06..00000000
--- a/docs/dev/models.rst
+++ /dev/null
@@ -1,81 +0,0 @@
-.. _models:
-
-Datastructures
-==============
-
-.. automodule:: mitmproxy.models
- :members: HTTPFlow, HTTPRequest, HTTPResponse
-
-
-.. automodule:: netlib.http
-
- .. autoclass:: Request
-
- .. rubric:: Data
- .. autoattribute:: first_line_format
- .. autoattribute:: method
- .. autoattribute:: scheme
- .. autoattribute:: host
- .. autoattribute:: port
- .. autoattribute:: path
- .. autoattribute:: http_version
- .. autoattribute:: headers
- .. autoattribute:: content
- .. autoattribute:: timestamp_start
- .. autoattribute:: timestamp_end
- .. rubric:: Computed Properties and Convenience Methods
- .. autoattribute:: text
- .. autoattribute:: url
- .. autoattribute:: pretty_host
- .. autoattribute:: pretty_url
- .. autoattribute:: query
- .. autoattribute:: cookies
- .. autoattribute:: path_components
- .. automethod:: anticache
- .. automethod:: anticomp
- .. automethod:: constrain_encoding
- .. autoattribute:: urlencoded_form
- .. autoattribute:: multipart_form
-
- .. autoclass:: Response
-
- .. automethod:: make
-
- .. rubric:: Data
- .. autoattribute:: http_version
- .. autoattribute:: status_code
- .. autoattribute:: reason
- .. autoattribute:: headers
- .. autoattribute:: content
- .. autoattribute:: timestamp_start
- .. autoattribute:: timestamp_end
- .. rubric:: Computed Properties and Convenience Methods
- .. autoattribute:: text
- .. autoattribute:: cookies
-
- .. autoclass:: Headers
- :members:
- :special-members:
- :no-undoc-members:
-
-.. automodule:: netlib.multidict
-
- .. autoclass:: MultiDictView
-
- .. automethod:: get_all
- .. automethod:: set_all
- .. automethod:: add
- .. automethod:: insert
- .. automethod:: keys
- .. automethod:: values
- .. automethod:: items
- .. automethod:: to_dict
-
-.. autoclass:: mitmproxy.models.Error
- :show-inheritance:
-
-.. autoclass:: mitmproxy.models.ServerConnection
- :show-inheritance:
-
-.. autoclass:: mitmproxy.models.ClientConnection
- :show-inheritance: \ No newline at end of file