From b13acd7956f2e09bf5f9001f8f55d018a381f6c2 Mon Sep 17 00:00:00 2001
From: Maximilian Hils <git@maximilianhils.com>
Date: Sat, 26 Sep 2015 01:23:59 +0200
Subject: adjust to netlib request changes + docs

---
 docs/Makefile       |  2 +-
 docs/conf.py        |  3 +++
 docs/dev/models.rst | 47 +++++++++++++++++++++++++++++++++++++++--------
 3 files changed, 43 insertions(+), 9 deletions(-)

(limited to 'docs')

diff --git a/docs/Makefile b/docs/Makefile
index a22bc8a2..99264d90 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -192,4 +192,4 @@ pseudoxml:
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 
 livehtml:
-	sphinx-autobuild -b html -z '../libmproxy' -r '___jb_(old|bak)___$$' $(ALLSPHINXOPTS) $(BUILDDIR)/html
\ No newline at end of file
+	sphinx-autobuild -b html -z '../libmproxy' -z '../../netlib/netlib' -r '___jb_(old|bak)___$$' $(ALLSPHINXOPTS) $(BUILDDIR)/html
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index 1e686007..ff4a4a86 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -40,6 +40,9 @@ extensions = [
     'sphinxcontrib.documentedlist'
 ]
 
+# https://github.com/sphinx-doc/sphinx/pull/2053
+napoleon_include_special_with_doc = False
+
 autodoc_member_order = "bysource"
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/docs/dev/models.rst b/docs/dev/models.rst
index 9929e4b2..617bcb1f 100644
--- a/docs/dev/models.rst
+++ b/docs/dev/models.rst
@@ -8,18 +8,49 @@ Models
     are missing**.
     Please read the source code instead.
 
-.. automodule:: libmproxy.models
-    :show-inheritance:
-    :members:
-    :undoc-members:
+.. automodule:: netlib.http
+
+    .. autoclass:: Request
+
+        .. rubric:: Data
+        .. autoattribute:: first_line_format
+        .. autoattribute:: method
+        .. autoattribute:: scheme
+        .. autoattribute:: host
+        .. autoattribute:: port
+        .. autoattribute:: path
+        .. autoattribute:: http_version
+        .. autoattribute:: headers
+        .. autoattribute:: content
+        .. autoattribute:: timestamp_start
+        .. autoattribute:: timestamp_end
+        .. rubric:: Computed Properties and Convenience Methods
+        .. autoattribute:: text
+        .. autoattribute:: url
+        .. autoattribute:: pretty_host
+        .. autoattribute:: pretty_url
+        .. autoattribute:: query
+        .. autoattribute:: cookies
+        .. autoattribute:: path_components
+        .. automethod:: anticache
+        .. automethod:: anticomp
+        .. automethod:: constrain_encoding
+        .. autoattribute:: urlencoded_form
+        .. autoattribute:: multipart_form
+
+    .. autoclass:: Response
 
+        .. warning:: Docs missing.
 
-.. automodule:: netlib.http.semantics
-    :members: Request, Response
-    :undoc-members:
 
     .. autoclass:: Headers
-        :show-inheritance:
         :members:
         :special-members:
         :no-undoc-members:
+
+
+    .. autoclass:: decoded
+
+.. automodule:: libmproxy.models
+    :show-inheritance:
+    :members: HTTPFlow, Error, ClientConnection, ServerConnection
\ No newline at end of file
-- 
cgit v1.2.3


From 1b6ea5caf3ab7c30cc4a822b81ad8288efbae70d Mon Sep 17 00:00:00 2001
From: Maximilian Hils <git@maximilianhils.com>
Date: Sat, 26 Sep 2015 17:41:14 +0200
Subject: adjust to netlib response changes + docs

---
 docs/dev/models.rst | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

(limited to 'docs')

diff --git a/docs/dev/models.rst b/docs/dev/models.rst
index 617bcb1f..b09c8bae 100644
--- a/docs/dev/models.rst
+++ b/docs/dev/models.rst
@@ -3,11 +3,6 @@
 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:: netlib.http
 
     .. autoclass:: Request
@@ -40,15 +35,23 @@ Models
 
     .. autoclass:: Response
 
-        .. warning:: Docs missing.
-
+        .. rubric:: Data
+        .. autoattribute:: http_version
+        .. autoattribute:: status_code
+        .. autoattribute:: reason
+        .. autoattribute:: headers
+        .. autoattribute:: content
+        .. autoattribute:: timestamp_start
+        .. autoattribute:: timestamp_end
+        .. rubric:: Computed Properties and Convenience Methods
+        .. autoattribute:: text
+        .. autoattribute:: cookies
 
     .. autoclass:: Headers
         :members:
         :special-members:
         :no-undoc-members:
 
-
     .. autoclass:: decoded
 
 .. automodule:: libmproxy.models
-- 
cgit v1.2.3