encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-01-24 00:04:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs for South v1.0

Browse Source
This commit is contained in:
Carlton Gibson 2014-08-18 13:48:46 +02:00
parent d98245ac22
commit ae2ab496c2
2 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api-guide/authentication.md
View File

@ -204,18 +204,11 @@ Note that the default `obtain_auth_token` view explicitly uses JSON requests and
#### Schema migrations
The `rest_framework.authtoken` app includes both a Django native migration (for Django versions >1.7) and a south migration that will create the authtoken table.
The `rest_framework.authtoken` app includes both Django native migrations (for Django versions >1.7) and South migrations (for Django versions <1.7) that will create the authtoken table.
----
**Note** By default both Django (>1.7) and South will look for a module named `migrations`. To avoid a collision here, in order to use South you **must** provide the `SOUTH_MIGRATION_MODULES` option in your `settings.py`:
SOUTH_MIGRATION_MODULES = {
'authtoken': 'rest_framework.authtoken.south_migrations',
}
This tells South to look in the `south_migrations` module for the `authtoken` app.
**Note**: From REST Framework v2.4.0 using South with Django <1.7 requires upgrading South v1.0+
----

7
docs/topics/release-notes.md
View File

@ -42,12 +42,9 @@ You can determine your currently installed version using `pip freeze`:
* Added compatibility with Django 1.7's native migrations.
**IMPORTANT**: In order to continue to use south with Django <1.7 you **must** provide
the `SOUTH_MIGRATION_MODULES` option in your `settings.py`:
**IMPORTANT**: In order to continue to use South with Django <1.7 you **must** upgrade to
South v1.0.
SOUTH_MIGRATION_MODULES = {
'authtoken': 'rest_framework.authtoken.south_migrations',
}
* Use py.test
* `@detail_route` and `@list_route` decorators replace `@action` and `@link`.
* `six` no longer bundled. For Django <= 1.4.1, install `six` package.