aboutsummaryrefslogtreecommitdiffstats
path: root/docs/dev/models.rst
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2015-09-16 02:53:01 +0200
committerMaximilian Hils <git@maximilianhils.com>2015-09-16 02:53:01 +0200
commit457025df9a64f312685774cb743eeb52cd37bd3f (patch)
tree98de6633322059ac95ab50e4b2d3129aa6051b58 /docs/dev/models.rst
parent436a9ea8398e25709f139fde609aa74e8fb3f3f8 (diff)
parentc3f73552b82923e8da224529895332c44bf8dace (diff)
downloadmitmproxy-457025df9a64f312685774cb743eeb52cd37bd3f.tar.gz
mitmproxy-457025df9a64f312685774cb743eeb52cd37bd3f.tar.bz2
mitmproxy-457025df9a64f312685774cb743eeb52cd37bd3f.zip
Merge pull request #751 from mitmproxy/readthedocs
Move Docs to readthedocs
Diffstat (limited to 'docs/dev/models.rst')
-rw-r--r--docs/dev/models.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/dev/models.rst b/docs/dev/models.rst
new file mode 100644
index 00000000..9929e4b2
--- /dev/null
+++ b/docs/dev/models.rst
@@ -0,0 +1,25 @@
+.. _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:
+
+ .. autoclass:: Headers
+ :show-inheritance:
+ :members:
+ :special-members:
+ :no-undoc-members: