From e8aca92ef1354110d3d82299539841a2fa1eac66 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Fri, 30 Sep 2016 09:54:35 +1000 Subject: [PATCH] docs: remove auto-generated stubs These are too verbose/low info for these docs. We should include pointers to where to start reading the code, and perhaps later we can include full auto-generated API docs separately. --- docs/dev/exceptions.rst | 9 --------- docs/dev/protocols.rst | 17 ----------------- docs/dev/proxy.rst | 12 ------------ docs/index.rst | 3 --- 4 files changed, 41 deletions(-) delete mode 100644 docs/dev/exceptions.rst delete mode 100644 docs/dev/protocols.rst delete mode 100644 docs/dev/proxy.rst diff --git a/docs/dev/exceptions.rst b/docs/dev/exceptions.rst deleted file mode 100644 index e890476b7..000000000 --- a/docs/dev/exceptions.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _exceptions: - -Exceptions -========== - -.. automodule:: mitmproxy.exceptions - :show-inheritance: - :members: - :undoc-members: diff --git a/docs/dev/protocols.rst b/docs/dev/protocols.rst deleted file mode 100644 index ee3681318..000000000 --- a/docs/dev/protocols.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _protocols: - -Protocols -========= - -.. automodule:: mitmproxy.protocol - - .. autoclass:: Layer - :members: - :special-members: - - .. autoclass:: ServerConnectionMixin - :members: - -.. seealso:: - - The :py:exc:`Kill ` exception to terminate connections. \ No newline at end of file diff --git a/docs/dev/proxy.rst b/docs/dev/proxy.rst deleted file mode 100644 index 888fb946a..000000000 --- a/docs/dev/proxy.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _proxy: - -Proxy Server -============ - -.. automodule:: mitmproxy.proxy - - .. autoclass:: ProxyServer - .. autoclass:: DummyServer - .. autoclass:: ProxyConfig - .. autoclass:: RootContext - :members: diff --git a/docs/index.rst b/docs/index.rst index 28c0c66f8..143f79f73 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -82,9 +82,6 @@ dev/architecture dev/testing dev/sslkeylogfile - dev/protocols - dev/proxy - dev/exceptions .. Indices and tables ==================