diff options
| author | Aldo Cortesi <aldo@nullcube.com> | 2016-10-12 10:57:05 +1300 |
|---|---|---|
| committer | Aldo Cortesi <aldo@nullcube.com> | 2016-10-16 20:26:06 +1300 |
| commit | fdb6a44245249a50b5c95cdf0d8d13ecddfe5726 (patch) | |
| tree | e173229b7b604641b8a103995e3ceb64276abf3c /docs/features | |
| parent | 26af9b29fc3fed60a003d097b3470e85115b2161 (diff) | |
| download | mitmproxy-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/features')
| -rw-r--r-- | docs/features/clientreplay.rst | 2 | ||||
| -rw-r--r-- | docs/features/responsestreaming.rst | 6 | ||||
| -rw-r--r-- | docs/features/serverreplay.rst | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/features/clientreplay.rst b/docs/features/clientreplay.rst index 50740bcf..ebe40b5f 100644 --- a/docs/features/clientreplay.rst +++ b/docs/features/clientreplay.rst @@ -14,5 +14,5 @@ You may want to use client-side replay in conjunction with the ================== =========== command-line ``-c path`` -mitmproxy shortcut :kbd:`c` +mitmproxy shortcut :kbd:`R` then :kbd:`c` ================== =========== diff --git a/docs/features/responsestreaming.rst b/docs/features/responsestreaming.rst index 66b5cae0..1d5726c4 100644 --- a/docs/features/responsestreaming.rst +++ b/docs/features/responsestreaming.rst @@ -35,10 +35,10 @@ command-line ``--stream SIZE`` Customizing Response Streaming ------------------------------ -You can also use an :ref:`inlinescripts` to customize exactly -which responses are streamed. +You can also use a script to customize exactly which responses are streamed. -Responses that should be tagged for streaming by setting their ``.stream`` attribute to ``True``: +Responses that should be tagged for streaming by setting their ``.stream`` +attribute to ``True``: .. literalinclude:: ../../examples/stream.py :caption: examples/stream.py diff --git a/docs/features/serverreplay.rst b/docs/features/serverreplay.rst index d70b6514..f545d4a5 100644 --- a/docs/features/serverreplay.rst +++ b/docs/features/serverreplay.rst @@ -35,5 +35,5 @@ the :kbd:`o` options shortcut within :program:`mitmproxy`. ================== =========== command-line ``-S path`` -mitmproxy shortcut :kbd:`S` +mitmproxy shortcut :kbd:`R` then :kbd:`s` ================== =========== |