diff options
| author | Tom Christie | 2011-05-17 09:15:35 +0100 |
|---|---|---|
| committer | Tom Christie | 2011-05-17 09:15:35 +0100 |
| commit | bfbb8ceccf209d6cd11723ead11e820e96e0accd (patch) | |
| tree | c21b9920403f1850ef70ccac2cb3c3dbfe3b5105 /docs/library | |
| parent | 3f6b6e437bf24a55c33af5379b8ae89974edba57 (diff) | |
| parent | 40573b2793a49d68b89ea5b6c4bff0e13470cc0c (diff) | |
| download | django-rest-framework-bfbb8ceccf209d6cd11723ead11e820e96e0accd.tar.bz2 | |
Merge Marko's doc improvements.
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/authentication.rst | 5 | ||||
| -rw-r--r-- | docs/library/authenticators.rst | 5 | ||||
| -rw-r--r-- | docs/library/compat.rst | 5 | ||||
| -rw-r--r-- | docs/library/emitters.rst | 7 | ||||
| -rw-r--r-- | docs/library/mixins.rst | 5 | ||||
| -rw-r--r-- | docs/library/modelresource.rst | 9 | ||||
| -rw-r--r-- | docs/library/permissions.rst | 5 | ||||
| -rw-r--r-- | docs/library/renderers.rst | 10 | ||||
| -rw-r--r-- | docs/library/validators.rst | 5 | ||||
| -rw-r--r-- | docs/library/views.rst | 5 |
10 files changed, 35 insertions, 26 deletions
diff --git a/docs/library/authentication.rst b/docs/library/authentication.rst new file mode 100644 index 00000000..d159f605 --- /dev/null +++ b/docs/library/authentication.rst @@ -0,0 +1,5 @@ +:mod:`authentication` +===================== + +.. automodule:: authentication + :members: diff --git a/docs/library/authenticators.rst b/docs/library/authenticators.rst deleted file mode 100644 index 407339f7..00000000 --- a/docs/library/authenticators.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`authenticators` -===================== - -.. automodule:: authenticators - :members: diff --git a/docs/library/compat.rst b/docs/library/compat.rst new file mode 100644 index 00000000..93fb081a --- /dev/null +++ b/docs/library/compat.rst @@ -0,0 +1,5 @@ +:mod:`compat`
+=====================
+
+.. automodule:: compat
+ :members:
diff --git a/docs/library/emitters.rst b/docs/library/emitters.rst deleted file mode 100644 index 590ace0f..00000000 --- a/docs/library/emitters.rst +++ /dev/null @@ -1,7 +0,0 @@ -:mod:`emitters` -=============== - -The emitters module provides a set of emitters that can be plugged in to a :class:`.Resource`. An emitter is responsible for taking the output of a and serializing it to a given media type. A :class:`.Resource` can have a number of emitters, allow the same content to be serialized in a number of different formats depending on the requesting client's preferences, as specified in the HTTP Request's Accept header. - -.. automodule:: emitters - :members: diff --git a/docs/library/mixins.rst b/docs/library/mixins.rst new file mode 100644 index 00000000..04bf66b0 --- /dev/null +++ b/docs/library/mixins.rst @@ -0,0 +1,5 @@ +:mod:`mixins`
+=====================
+
+.. automodule:: mixins
+ :members:
diff --git a/docs/library/modelresource.rst b/docs/library/modelresource.rst deleted file mode 100644 index af760944..00000000 --- a/docs/library/modelresource.rst +++ /dev/null @@ -1,9 +0,0 @@ -:mod:`modelresource` -==================== - -.. note:: - - TODO - document this module properly - -.. automodule:: modelresource - :members: diff --git a/docs/library/permissions.rst b/docs/library/permissions.rst new file mode 100644 index 00000000..c694d639 --- /dev/null +++ b/docs/library/permissions.rst @@ -0,0 +1,5 @@ +:mod:`permissions`
+=====================
+
+.. automodule:: permissions
+ :members:
diff --git a/docs/library/renderers.rst b/docs/library/renderers.rst new file mode 100644 index 00000000..a9e72931 --- /dev/null +++ b/docs/library/renderers.rst @@ -0,0 +1,10 @@ +:mod:`renderers` +================ + +The renderers module provides a set of renderers that can be plugged in to a :class:`.Resource`. +A renderer is responsible for taking the output of a View and serializing it to a given media type. +A :class:`.Resource` can have a number of renderers, allow the same content to be serialized in a number +of different formats depending on the requesting client's preferences, as specified in the HTTP Request's Accept header. + +.. automodule:: renderers + :members: diff --git a/docs/library/validators.rst b/docs/library/validators.rst deleted file mode 100644 index 5d8b1dd7..00000000 --- a/docs/library/validators.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`validators` -================= - -.. automodule:: validators - :members: diff --git a/docs/library/views.rst b/docs/library/views.rst new file mode 100644 index 00000000..329b487b --- /dev/null +++ b/docs/library/views.rst @@ -0,0 +1,5 @@ +:mod:`views`
+=====================
+
+.. automodule:: views
+ :members:
|