From 40d1821f2d81f822fff9b85691073ab069edb847 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 5 Sep 2012 10:01:43 +0100 Subject: [PATCH] Add missing doc files --- docs/api-guide/authentication.md | 9 ++++++++ docs/api-guide/permissions.md | 1 + docs/api-guide/{urls.md => reverse.md} | 0 docs/api-guide/settings.md | 31 ++++++++++++++++++++++++++ docs/api-guide/throttling.md | 1 + docs/index.md | 8 +++++-- docs/template.html | 3 ++- 7 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 docs/api-guide/authentication.md create mode 100644 docs/api-guide/permissions.md rename docs/api-guide/{urls.md => reverse.md} (100%) create mode 100644 docs/api-guide/settings.md create mode 100644 docs/api-guide/throttling.md diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md new file mode 100644 index 000000000..76aaba8a1 --- /dev/null +++ b/docs/api-guide/authentication.md @@ -0,0 +1,9 @@ +# Authentication + +REST framework provides a number of authentication policies out of the box, and also allows you to implement custom policies. + +## BasicAuthentication + +## TokenBasicAuthentication + +## SessionAuthentication diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/docs/api-guide/permissions.md @@ -0,0 +1 @@ + diff --git a/docs/api-guide/urls.md b/docs/api-guide/reverse.md similarity index 100% rename from docs/api-guide/urls.md rename to docs/api-guide/reverse.md diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md new file mode 100644 index 000000000..c7bae30d1 --- /dev/null +++ b/docs/api-guide/settings.md @@ -0,0 +1,31 @@ +# Settings + +Settings for REST framework are all namespaced in the `API_SETTINGS` setting. +For example your project's `settings.py` file might look like this: + + API_SETTINGS = { + 'DEFAULT_RENDERERS': ( + 'djangorestframework.renderers.JSONRenderer', + 'djangorestframework.renderers.YAMLRenderer', + ) + 'DEFAULT_PARSERS': ( + 'djangorestframework.parsers.JSONParser', + 'djangorestframework.parsers.YAMLParser', + ) + } + +## DEFAULT_RENDERERS + +A list or tuple of renderer classes. + +Default: + + ( + 'djangorestframework.renderers.JSONRenderer', + 'djangorestframework.renderers.DocumentingHTMLRenderer')` + +## DEFAULT_PARSERS + +A list or tuple of parser classes. + +Default: `()` diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/docs/api-guide/throttling.md @@ -0,0 +1 @@ + diff --git a/docs/index.md b/docs/index.md index 25cab3984..6b7574b1e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -79,9 +79,11 @@ The API guide is your complete reference manual to all the functionality provide * [Serializers][serializers] * [Authentication][authentication] * [Permissions][permissions] +* [Throttling][throttling] * [Exceptions][exceptions] * [Status codes][status] -* [Returning URLs][urls] +* [Returning URLs][reverse] +* [Settings][settings] ## Topics @@ -147,9 +149,11 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [serializers]: api-guide/serializers.md [authentication]: api-guide/authentication.md [permissions]: api-guide/permissions.md +[throttling]: api-guide/throttling.md [exceptions]: api-guide/exceptions.md [status]: api-guide/status.md -[urls]: api-guide/urls.md +[reverse]: api-guide/reverse.md +[settings]: api-guide/settings.md [csrf]: topics/csrf.md [formoverloading]: topics/formoverloading.md diff --git a/docs/template.html b/docs/template.html index e452ead73..2c3572e17 100644 --- a/docs/template.html +++ b/docs/template.html @@ -94,7 +94,8 @@ margin-top: 5px;
  • Throttling
  • Exceptions
  • Status codes
  • -
  • Returning URLs
  • +
  • Returning URLs
  • +
  • Settings