From d84fc645a711c5e420c78dd1b49148c8973e9a5a Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sat, 30 Apr 2016 15:25:02 -0700 Subject: [PATCH] docs: minor fixes --- docs/dev/models.rst | 1 + docs/dev/protocols.rst | 4 +++- docs/install.rst | 2 +- docs/scripting/inlinescripts.rst | 2 +- web/src/js/components/header.js | 2 +- 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/dev/models.rst b/docs/dev/models.rst index 2eac67835..8c4e68252 100644 --- a/docs/dev/models.rst +++ b/docs/dev/models.rst @@ -60,4 +60,5 @@ Datastructures .. automodule:: mitmproxy.models :show-inheritance: + :noindex: :members: Error, ServerConnection, ClientConnection \ No newline at end of file diff --git a/docs/dev/protocols.rst b/docs/dev/protocols.rst index ceb5c2fdb..ee3681318 100644 --- a/docs/dev/protocols.rst +++ b/docs/dev/protocols.rst @@ -12,4 +12,6 @@ Protocols .. autoclass:: ServerConnectionMixin :members: - .. autoexception:: Kill +.. seealso:: + + The :py:exc:`Kill ` exception to terminate connections. \ No newline at end of file diff --git a/docs/install.rst b/docs/install.rst index fcdfc8c92..566430f54 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -32,7 +32,7 @@ Then see the Hacking_ section of the README on GitHub. .. _install-arch: Installation On Arch Linux ----------------------- +-------------------------- mitmproxy has been added into the [community] repository. Use pacman to install it: diff --git a/docs/scripting/inlinescripts.rst b/docs/scripting/inlinescripts.rst index 89bff2c14..d282dfa6d 100644 --- a/docs/scripting/inlinescripts.rst +++ b/docs/scripting/inlinescripts.rst @@ -212,7 +212,7 @@ Running scripts on saved flows Sometimes, we want to run a script on :py:class:`~mitmproxy.models.Flow` objects that are already complete. This happens when you start a script, and then load a saved set of flows from a file -(see the "scripted data transformation" example `here `_). +(see the "scripted data transformation" example :ref:`here `). It also happens when you run a one-shot script on a single flow through the ``|`` (pipe) shortcut in mitmproxy. diff --git a/web/src/js/components/header.js b/web/src/js/components/header.js index 1af928a3b..b41108510 100644 --- a/web/src/js/components/header.js +++ b/web/src/js/components/header.js @@ -38,7 +38,7 @@ var FilterDocs = React.createClass({ }); commands.push( -   mitmproxy docs