summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorSergey Schetinin <sergey@maluke.com>2011-07-07 21:32:16 +0300
committerSergey Schetinin <sergey@maluke.com>2011-07-07 21:32:16 +0300
commit0979dca7ce60fc3800bfcb19f0d3168bf96bf0cd (patch)
tree300e969c44621e9b5545a9c48863fd5a6e17541b /docs/modules
parentcc3af5f0bcdaac4efe6a80713352fb5dda5e5112 (diff)
downloadwebob-0979dca7ce60fc3800bfcb19f0d3168bf96bf0cd.tar.gz
fix docs, adjust tests for docstrings
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/dec.txt1
-rw-r--r--docs/modules/webob.txt84
2 files changed, 53 insertions, 32 deletions
diff --git a/docs/modules/dec.txt b/docs/modules/dec.txt
index 96f8d0d..3c9e7a2 100644
--- a/docs/modules/dec.txt
+++ b/docs/modules/dec.txt
@@ -7,3 +7,4 @@ Decorator
---------
.. autoclass:: wsgify
+ :members:
diff --git a/docs/modules/webob.txt b/docs/modules/webob.txt
index 7828c95..5eed7cf 100644
--- a/docs/modules/webob.txt
+++ b/docs/modules/webob.txt
@@ -1,46 +1,58 @@
:mod:`webob` -- Request/Response objects
========================================
-.. automodule:: webob
-
Request
-------
-.. autoclass:: Request
-
-.. automodule:: webob.acceptparse
-.. autoclass:: Accept
-.. autoclass:: MIMEAccept
+.. autoclass:: webob.request.BaseRequest
+ :members:
-.. automodule:: webob.byterange
-.. autoclass:: Range
+Response
+--------
-.. automodule:: webob.cachecontrol
-.. autoclass:: CacheControl
+.. autoclass:: webob.response.Response
+ :members:
+.. autoclass:: webob.response.AppIterRange
+ :members:
-.. automodule:: webob.headers
-.. autoclass:: EnvironHeaders
-.. automodule:: webob.etag
-.. autoclass:: ETagMatcher
-.. autoclass:: IfRange
+Headers
+-------
+Accept-*
+~~~~~~~~
-Response
---------
+.. automodule:: webob.acceptparse
+.. autoclass:: Accept
+ :members:
+.. autoclass:: MIMEAccept
+ :members:
-.. autoclass:: webob.Response
+Cache-Control
+~~~~~~~~~~~~~
+.. autoclass:: webob.cachecontrol.CacheControl
+ :members:
+Range and related headers
+~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: webob.byterange.Range
+ :members:
.. autoclass:: webob.byterange.ContentRange
+ :members:
+.. autoclass:: webob.etag.IfRange
+ :members:
+
+ETag
+~~~~
+.. autoclass:: webob.etag.ETagMatcher
+ :members:
+
-.. autoclass:: webob.cachecontrol.CacheControl
-.. automodule:: webob.headers
-.. autoclass:: ResponseHeaders
-Misc Functions
---------------
+Misc Functions and Internals
+----------------------------
.. autofunction:: webob.html_escape
@@ -54,22 +66,30 @@ Misc Functions
.. autoclass:: webob.month
.. autoclass:: webob.year
-.. autoclass:: webob.response.AppIterRange
+.. autoclass:: webob.headers.ResponseHeaders
+ :members:
+.. autoclass:: webob.headers.EnvironHeaders
+ :members:
.. automodule:: webob.multidict
.. autoclass:: MultiDict
+ :members:
.. autoclass:: UnicodeMultiDict
+ :members:
.. autoclass:: NestedMultiDict
+ :members:
.. autoclass:: NoVars
+ :members:
-.. automodule:: webob.cachecontrol
.. autoclass:: webob.cachecontrol.UpdateDict
+ :members:
-Descriptors
------------
+.. comment:
+ Descriptors
+ -----------
-.. autoclass:: webob.descriptors.environ_getter
-.. autoclass:: webob.descriptors.header_getter
-.. autoclass:: webob.descriptors.converter
-.. autoclass:: webob.descriptors.deprecated_property
+ .. autoclass:: webob.descriptors.environ_getter
+ .. autoclass:: webob.descriptors.header_getter
+ .. autoclass:: webob.descriptors.converter
+ .. autoclass:: webob.descriptors.deprecated_property