diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2016-04-11 14:13:48 -0700 |
|---|---|---|
| committer | Maximilian Hils <git@maximilianhils.com> | 2016-04-11 14:13:48 -0700 |
| commit | 14e9b0a0ac5ca8c1177e0e501906f43511798ca1 (patch) | |
| tree | 26ab091fbfe48d07e02c2ac828fadafff6427269 /docs | |
| parent | 7208a7543f4ad04cfbf304a66ea857540dbb0989 (diff) | |
| download | mitmproxy-14e9b0a0ac5ca8c1177e0e501906f43511798ca1.tar.gz mitmproxy-14e9b0a0ac5ca8c1177e0e501906f43511798ca1.tar.bz2 mitmproxy-14e9b0a0ac5ca8c1177e0e501906f43511798ca1.zip | |
docs: better data structure docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/dev/models.rst | 10 | ||||
| -rw-r--r-- | docs/dev/testing.rst | 2 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/scripting/mitmproxy.rst | 6 |
5 files changed, 13 insertions, 9 deletions
diff --git a/docs/Makefile b/docs/Makefile index 74bcda53..b8255107 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -192,4 +192,4 @@ pseudoxml: @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." livehtml: - sphinx-autobuild -b html -z '../mitmproxy' -z '../../netlib/netlib' -r '___jb_(old|bak)___$$' $(ALLSPHINXOPTS) $(BUILDDIR)/html
\ No newline at end of file + sphinx-autobuild -b html -z '../mitmproxy' -r '___jb_(old|bak|tmp)___$$' $(ALLSPHINXOPTS) $(BUILDDIR)/html
\ No newline at end of file diff --git a/docs/dev/models.rst b/docs/dev/models.rst index 7a949941..2eac6783 100644 --- a/docs/dev/models.rst +++ b/docs/dev/models.rst @@ -1,7 +1,11 @@ .. _models: -Models -====== +Datastructures +============== + +.. automodule:: mitmproxy.models + :members: HTTPFlow, HTTPRequest, HTTPResponse + .. automodule:: netlib.http @@ -56,4 +60,4 @@ Models .. automodule:: mitmproxy.models :show-inheritance: - :members: HTTPFlow, Error, ClientConnection, ServerConnection
\ No newline at end of file + :members: Error, ServerConnection, ClientConnection
\ No newline at end of file diff --git a/docs/dev/testing.rst b/docs/dev/testing.rst index e3b86bf3..c9ed5164 100644 --- a/docs/dev/testing.rst +++ b/docs/dev/testing.rst @@ -10,7 +10,7 @@ suitable extension to the test suite. Our tests are written for the `py.test`_ or nose_ test frameworks. At the point where you send your pull request, a command like this: ->>> py.test -n 4 --cov mitmproxy +>>> py.test --cov mitmproxy --cov netlib Should give output something like this: diff --git a/docs/index.rst b/docs/index.rst index 4bca07d1..d3b6f434 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -52,6 +52,7 @@ :caption: Scripting scripting/inlinescripts + dev/models scripting/mitmproxy @@ -73,7 +74,6 @@ dev/protocols dev/proxy dev/exceptions - dev/models .. Indices and tables ================== diff --git a/docs/scripting/mitmproxy.rst b/docs/scripting/mitmproxy.rst index 73450df5..9e331736 100644 --- a/docs/scripting/mitmproxy.rst +++ b/docs/scripting/mitmproxy.rst @@ -1,10 +1,10 @@ -mitmproxy -========= +FlowMaster +========== .. note:: - We strongly encourage you to use :ref:`inlinescripts` rather than mitmproxy. + We strongly encourage you to use :ref:`inlinescripts` rather than subclassing mitmproxy's FlowMaster. - Inline Scripts are equally powerful and provide an easier syntax. - Most examples are written as inline scripts. - Multiple inline scripts can be used together. |