diff options
| author | markotibold | 2011-05-16 23:54:35 +0200 |
|---|---|---|
| committer | markotibold | 2011-05-16 23:54:35 +0200 |
| commit | 304786657a8cbff323f21b7297c142f6ca5a1cc1 (patch) | |
| tree | ad79511812ecf5f1b49a715efb6b3393173de2e5 /docs | |
| parent | 3039f6f6c29d0b469810adcd6ba450361f2a16de (diff) | |
| download | django-rest-framework-304786657a8cbff323f21b7297c142f6ca5a1cc1.tar.bz2 | |
Getting rid of all errors and warnings that show up when building the docs, to make a clean start with the library documentation .
--HG--
rename : docs/library/authenticators.rst => docs/library/authentication.rst
rename : docs/library/emitters.rst => docs/library/renderers.rst
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/examples/blogpost.rst | 6 | ||||
| -rw-r--r-- | docs/index.rst | 8 | ||||
| -rw-r--r-- | docs/library/authentication.rst | 5 | ||||
| -rw-r--r-- | docs/library/authenticators.rst | 5 | ||||
| -rw-r--r-- | docs/library/emitters.rst | 7 | ||||
| -rw-r--r-- | docs/library/modelresource.rst | 9 | ||||
| -rw-r--r-- | docs/library/renderers.rst | 10 |
7 files changed, 22 insertions, 28 deletions
diff --git a/docs/examples/blogpost.rst b/docs/examples/blogpost.rst index 07f7cbc5..9d762f52 100644 --- a/docs/examples/blogpost.rst +++ b/docs/examples/blogpost.rst @@ -27,7 +27,7 @@ Creating the resources Once we have some existing models there's very little we need to do to create the corresponding resources. We simply create a base resource and an instance resource for each model we're working with. django-rest-framework will provide the default operations on the resources all the usual input validation that Django's models can give us for free. -``views.py`` +#``views.py`` -.. include:: ../../examples/blogpost/views.py - :literal:
\ No newline at end of file +#.. include:: ../../examples/blogpost/views.py +# :literal:
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 4da2da1c..fac1c94b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,7 +36,8 @@ Resources Any and all questions, thoughts, bug reports and contributions are *hugely appreciated*. -We'd like for this to be a real community driven effort, so come say hi, get involved, and get forking! (See: `Bitbucket <http://confluence.atlassian.com/display/BITBUCKET/Forking+a+Bitbucket+Repository>`_, `GitHub <http://help.github.com/fork-a-repo/>`_) +We'd like for this to be a real community driven effort, so come say hi, get involved, and get forking! (See: `Forking a Bitbucket Repository +<http://confluence.atlassian.com/display/BITBUCKET/Forking+a+Bitbucket+Repository>`_, or `Fork A GitHub Repo <http://help.github.com/fork-a-repo/>`_) Requirements ------------ @@ -140,10 +141,9 @@ Library Reference :maxdepth: 1 library/resource - library/modelresource - library/emitters + library/renderers library/parsers - library/authenticators + library/authentication library/validators library/response library/status 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/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/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/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: |
