diff options
| -rw-r--r-- | docs/examples/permissions.rst | 4 | ||||
| -rw-r--r-- | docs/howto/mixin.rst | 6 | ||||
| -rw-r--r-- | docs/howto/setup.rst | 12 | ||||
| -rw-r--r-- | docs/howto/usingurllib2.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
5 files changed, 16 insertions, 11 deletions
diff --git a/docs/examples/permissions.rst b/docs/examples/permissions.rst index cfd7b446..eafc3255 100644 --- a/docs/examples/permissions.rst +++ b/docs/examples/permissions.rst @@ -60,7 +60,7 @@ both:: permissions = (PerUserThrottling, Isauthenticated) -To see what other throttles are available, have a look at the :doc:`../library/permissions` module. +To see what other throttles are available, have a look at the :mod:`permissions` module. -If you want to implement your own authentication method, then refer to the :doc:`../library/authentication` +If you want to implement your own authentication method, then refer to the :mod:`authentication` module. diff --git a/docs/howto/mixin.rst b/docs/howto/mixin.rst index d8b1c4f0..1a84f2ad 100644 --- a/docs/howto/mixin.rst +++ b/docs/howto/mixin.rst @@ -1,8 +1,7 @@ Using Django REST framework Mixin classes ========================================= -This example demonstrates creating a REST API **without** using Django REST framework's :class:`.Resource` or :class:`.ModelResource`, -but instead using Django :class:`View` class, and adding the :class:`EmitterMixin` class to provide full HTTP Accept header content negotiation, +This example demonstrates creating a REST API **without** using Django REST framework's :class:`.Resource` or :class:`.ModelResource`, but instead using Django's :class:`View` class, and adding the :class:`ResponseMixin` class to provide full HTTP Accept header content negotiation, a browseable Web API, and much of the other goodness that Django REST framework gives you for free. .. note:: @@ -26,5 +25,6 @@ Everything we need for this example can go straight into the URL conf... .. include:: ../../examples/mixin/urls.py :literal: -That's it. Auto-magically our API now supports multiple output formats, specified either by using standard HTTP Accept header content negotiation, or by using the `&_accept=application/json` style parameter overrides. +That's it. Auto-magically our API now supports multiple output formats, specified either by using +standard HTTP Accept header content negotiation, or by using the `&_accept=application/json` style parameter overrides. We even get a nice HTML view which can be used to self-document our API. diff --git a/docs/howto/setup.rst b/docs/howto/setup.rst index a9053f73..f14e0499 100644 --- a/docs/howto/setup.rst +++ b/docs/howto/setup.rst @@ -13,7 +13,7 @@ If you need to manually install Django REST framework to your ``site-packages`` Template Loaders ---------------- -Django REST framework uses a few templates for the HTML and plain text documenting emitters. +Django REST framework uses a few templates for the HTML and plain text documenting renderers. * Ensure ``TEMPLATE_LOADERS`` setting contains ``'django.template.loaders.app_directories.Loader'``. @@ -22,16 +22,20 @@ This will be the case by default so you shouldn't normally need to do anything h Admin Styling ------------- -Django REST framework uses the admin media for styling. When running using Django's testserver this is automatically served for you, but once you move onto a production server, you'll want to make sure you serve the admin media separately, exactly as you would do `if using the Django admin <https://docs.djangoproject.com/en/dev/howto/deployment/modpython/#serving-the-admin-files>`_. +Django REST framework uses the admin media for styling. When running using Django's testserver this is automatically served for you, +but once you move onto a production server, you'll want to make sure you serve the admin media separately, exactly as you would do +`if using the Django admin <https://docs.djangoproject.com/en/dev/howto/deployment/modpython/#serving-the-admin-files>`_. -* Ensure that the ``ADMIN_MEDIA_PREFIX`` is set appropriately and that you are serving the admin media. (Django's testserver will automatically serve the admin media for you) +* Ensure that the ``ADMIN_MEDIA_PREFIX`` is set appropriately and that you are serving the admin media. + (Django's testserver will automatically serve the admin media for you) Markdown -------- The Python `markdown library <http://www.freewisdom.org/projects/python-markdown/>`_ is not required but comes recommended. -If markdown is installed your :class:`.Resource` descriptions can include `markdown style formatting <http://daringfireball.net/projects/markdown/syntax>`_ which will be rendered by the HTML documenting emitter. +If markdown is installed your :class:`.Resource` descriptions can include `markdown style formatting +<http://daringfireball.net/projects/markdown/syntax>`_ which will be rendered by the HTML documenting renderer. robots.txt, favicon, login/logout --------------------------------- diff --git a/docs/howto/usingurllib2.rst b/docs/howto/usingurllib2.rst index 139bf717..6320dc20 100644 --- a/docs/howto/usingurllib2.rst +++ b/docs/howto/usingurllib2.rst @@ -1,5 +1,5 @@ -Using urllib2 -============= +Using urllib2 with Django REST Framework +======================================== Python's standard library comes with some nice modules you can use to test your api or even write a full client. diff --git a/docs/index.rst b/docs/index.rst index b105e1ab..0221ea05 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,7 @@ Django REST framework is a lightweight REST framework for Django, that aims to m **Browse example APIs created with Django REST framework:** `The Sandbox <http://rest.ep.io/>`_ Features: +--------- * Automatically provides an awesome Django admin style `browse-able self-documenting API <http://rest.ep.io>`_. * Clean, simple, views for Resources, using Django's new `class based views <http://docs.djangoproject.com/en/dev/topics/class-based-views/>`_. |