aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTom Christie2012-09-05 10:01:43 +0100
committerTom Christie2012-09-05 10:01:43 +0100
commit40d1821f2d81f822fff9b85691073ab069edb847 (patch)
treeff46d03e0a7def9c218d444718788cbe473ce03b /docs
parentda4fa9bded9bbbbacf2a3009e1e211bdd51e287a (diff)
downloaddjango-rest-framework-40d1821f2d81f822fff9b85691073ab069edb847.tar.bz2
Add missing doc files
Diffstat (limited to 'docs')
-rw-r--r--docs/api-guide/authentication.md9
-rw-r--r--docs/api-guide/permissions.md1
-rw-r--r--docs/api-guide/reverse.md (renamed from docs/api-guide/urls.md)0
-rw-r--r--docs/api-guide/settings.md31
-rw-r--r--docs/api-guide/throttling.md1
-rw-r--r--docs/index.md8
-rw-r--r--docs/template.html3
7 files changed, 50 insertions, 3 deletions
diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md
new file mode 100644
index 00000000..76aaba8a
--- /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 00000000..8b137891
--- /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
index c39ff8f6..c39ff8f6 100644
--- a/docs/api-guide/urls.md
+++ b/docs/api-guide/reverse.md
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
new file mode 100644
index 00000000..c7bae30d
--- /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 00000000..8b137891
--- /dev/null
+++ b/docs/api-guide/throttling.md
@@ -0,0 +1 @@
+
diff --git a/docs/index.md b/docs/index.md
index 25cab398..6b7574b1 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 e452ead7..2c3572e1 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -94,7 +94,8 @@ margin-top: 5px;
<li><a href="{{ base_url }}/api-guide/throttling{{ suffix }}">Throttling</a></li>
<li><a href="{{ base_url }}/api-guide/exceptions{{ suffix }}">Exceptions</a></li>
<li><a href="{{ base_url }}/api-guide/status-codes{{ suffix }}">Status codes</a></li>
- <li><a href="{{ base_url }}/api-guide/urls{{ suffix }}">Returning URLs</a></li>
+ <li><a href="{{ base_url }}/api-guide/reverse{{ suffix }}">Returning URLs</a></li>
+ <li><a href="{{ base_url }}/api-guide/settings{{ suffix }}">Settings</a></li>
</ul>
</li>
<li class="dropdown">