mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-01-24 08:14:16 +03:00
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
This commit is contained in:
parent
3039f6f6c2
commit
304786657a
|
@ -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:
|
||||
#.. include:: ../../examples/blogpost/views.py
|
||||
# :literal:
|
|
@ -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
|
||||
|
|
5
docs/library/authentication.rst
Normal file
5
docs/library/authentication.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
:mod:`authentication`
|
||||
=====================
|
||||
|
||||
.. automodule:: authentication
|
||||
:members:
|
|
@ -1,5 +0,0 @@
|
|||
:mod:`authenticators`
|
||||
=====================
|
||||
|
||||
.. automodule:: authenticators
|
||||
:members:
|
|
@ -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:
|
|
@ -1,9 +0,0 @@
|
|||
:mod:`modelresource`
|
||||
====================
|
||||
|
||||
.. note::
|
||||
|
||||
TODO - document this module properly
|
||||
|
||||
.. automodule:: modelresource
|
||||
:members:
|
10
docs/library/renderers.rst
Normal file
10
docs/library/renderers.rst
Normal file
|
@ -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:
|
Loading…
Reference in New Issue
Block a user