diff options
author | Aldo Cortesi <aldo@nullcube.com> | 2016-09-30 09:54:35 +1000 |
---|---|---|
committer | Aldo Cortesi <aldo@nullcube.com> | 2016-09-30 09:54:35 +1000 |
commit | e8aca92ef1354110d3d82299539841a2fa1eac66 (patch) | |
tree | 39dee3997718eb6d3634f46d68448df068428e4f /docs | |
parent | 7998c1ff86a0890eedc8b5c5f8ecfc7bc70639ea (diff) | |
download | mitmproxy-e8aca92ef1354110d3d82299539841a2fa1eac66.tar.gz mitmproxy-e8aca92ef1354110d3d82299539841a2fa1eac66.tar.bz2 mitmproxy-e8aca92ef1354110d3d82299539841a2fa1eac66.zip |
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.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/exceptions.rst | 9 | ||||
-rw-r--r-- | docs/dev/protocols.rst | 17 | ||||
-rw-r--r-- | docs/dev/proxy.rst | 12 | ||||
-rw-r--r-- | docs/index.rst | 3 |
4 files changed, 0 insertions, 41 deletions
diff --git a/docs/dev/exceptions.rst b/docs/dev/exceptions.rst deleted file mode 100644 index e890476b..00000000 --- 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 ee368131..00000000 --- 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 <mitmproxy.exceptions.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 888fb946..00000000 --- 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 28c0c66f..143f79f7 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 ================== |