aboutsummaryrefslogtreecommitdiffstats
path: root/docs/dev
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/exceptions.rst9
-rw-r--r--docs/dev/models.rst19
-rw-r--r--docs/dev/protocols.rst15
-rw-r--r--docs/dev/proxy.rst12
4 files changed, 55 insertions, 0 deletions
diff --git a/docs/dev/exceptions.rst b/docs/dev/exceptions.rst
new file mode 100644
index 00000000..d1e4bfe5
--- /dev/null
+++ b/docs/dev/exceptions.rst
@@ -0,0 +1,9 @@
+.. _exceptions:
+
+Exceptions
+==========
+
+.. automodule:: libmproxy.exceptions
+ :show-inheritance:
+ :members:
+ :undoc-members: \ No newline at end of file
diff --git a/docs/dev/models.rst b/docs/dev/models.rst
new file mode 100644
index 00000000..1ac7d042
--- /dev/null
+++ b/docs/dev/models.rst
@@ -0,0 +1,19 @@
+.. _models:
+
+Models
+======
+
+.. warning::
+ The documentation for models has not been converted to rst yet and **many attributes/features
+ are missing**.
+ Please read the source code instead.
+
+.. automodule:: libmproxy.models
+ :show-inheritance:
+ :members:
+ :undoc-members:
+
+
+.. automodule:: netlib.http.semantics
+ :members: Request, Response
+ :undoc-members: \ No newline at end of file
diff --git a/docs/dev/protocols.rst b/docs/dev/protocols.rst
new file mode 100644
index 00000000..498f634d
--- /dev/null
+++ b/docs/dev/protocols.rst
@@ -0,0 +1,15 @@
+.. _protocols:
+
+Protocols
+=========
+
+.. automodule:: libmproxy.protocol
+
+ .. autoclass:: Layer
+ :members:
+ :special-members:
+
+ .. autoclass:: ServerConnectionMixin
+ :members:
+
+ .. autoexception:: Kill \ No newline at end of file
diff --git a/docs/dev/proxy.rst b/docs/dev/proxy.rst
new file mode 100644
index 00000000..c0cdb259
--- /dev/null
+++ b/docs/dev/proxy.rst
@@ -0,0 +1,12 @@
+.. _proxy:
+
+Proxy Server
+============
+
+.. automodule:: libmproxy.proxy
+
+ .. autoclass:: ProxyServer
+ .. autoclass:: DummyServer
+ .. autoclass:: ProxyConfig
+ .. autoclass:: RootContext
+ :members: \ No newline at end of file