aboutsummaryrefslogtreecommitdiffstats
path: root/docs/library
diff options
context:
space:
mode:
authortom christie tom@tomchristie.com2011-02-19 13:12:35 +0000
committertom christie tom@tomchristie.com2011-02-19 13:12:35 +0000
commite4fff6ea6e5422af23c324897ed1cff8f8a6e903 (patch)
tree030c0d0a02e25ffdef43781fbc815dbce48dd16d /docs/library
parent57b3a372f2122d022f9d6f43818e5fe9d318ce03 (diff)
downloaddjango-rest-framework-e4fff6ea6e5422af23c324897ed1cff8f8a6e903.tar.bz2
Clean up the docs
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/authenticators.rst29
-rw-r--r--docs/library/resource.rst2
-rw-r--r--docs/library/status.rst5
-rw-r--r--docs/library/validators.rst5
4 files changed, 13 insertions, 28 deletions
diff --git a/docs/library/authenticators.rst b/docs/library/authenticators.rst
index ec49c246..407339f7 100644
--- a/docs/library/authenticators.rst
+++ b/docs/library/authenticators.rst
@@ -1,30 +1,5 @@
:mod:`authenticators`
=====================
-.. module:: authenticators
-
-The authenticators module provides a standard set of authentication methods that can be plugged in to a :class:`.Resource`, as well as providing a template by which to write custom authentication methods.
-
-The base class
---------------
-
-All authenticators must subclass the :class:`BaseAuthenticator` class and override it's :func:`authenticate` method.
-
-.. class:: BaseAuthenticator
-
- .. method:: authenticate(request)
-
- Authenticate the request and return the authentication context or None.
-
- The default permission checking on :class:`.Resource` will use the allowed_methods attribute for permissions if the authentication context is not None, and use anon_allowed_methods otherwise.
-
- The authentication context is passed to the handler calls (eg :meth:`.Resource.get`, :meth:`.Resource.post` etc...) in order to allow them to apply any more fine grained permission checking at the point the response is being generated.
-
- This function must be overridden to be implemented.
-
-Provided authenticators
------------------------
-
-.. note::
-
- TODO - document this module properly
+.. automodule:: authenticators
+ :members:
diff --git a/docs/library/resource.rst b/docs/library/resource.rst
index a34d63fb..b6cf028e 100644
--- a/docs/library/resource.rst
+++ b/docs/library/resource.rst
@@ -3,7 +3,7 @@
.. module:: resource
-The :mod:`resource` module is the core of FlyWheel. It provides the :class:`Resource` base class which handles incoming HTTP requests and maps them to method calls, performing authentication, input deserialization, input validation and output serialization.
+The :mod:`resource` module is the core of Django REST framework. It provides the :class:`Resource` base class which handles incoming HTTP requests and maps them to method calls, performing authentication, input deserialization, input validation and output serialization.
Resources are created by sublassing :class:`Resource`, setting a number of class attributes, and overriding one or more methods.
diff --git a/docs/library/status.rst b/docs/library/status.rst
new file mode 100644
index 00000000..0c7596bc
--- /dev/null
+++ b/docs/library/status.rst
@@ -0,0 +1,5 @@
+:mod:`status`
+===============
+
+.. automodule:: status
+ :members:
diff --git a/docs/library/validators.rst b/docs/library/validators.rst
new file mode 100644
index 00000000..acca71eb
--- /dev/null
+++ b/docs/library/validators.rst
@@ -0,0 +1,5 @@
+:mod:`validators`
+===============
+
+.. automodule:: validators
+ :members: