Commit Graph

1626 Commits

Author SHA1 Message Date
Tom Christie
64d8e3dcb6 Typo. Refs #2132. 2014-11-25 13:50:35 +00:00
José Padilla
38fe2c9dad Document writing third party packages
Add the following sections:
- “About Third Party Packages”
- “How to create a Third Party Package”
- “Existing Third Party Packages”

Resolve #2043
2014-11-25 09:38:48 -04:00
Dougal Matthews
673f48242f Remove commented out title 2014-11-25 13:11:30 +00:00
Dougal Matthews
a0c12bf7c5 Change the background of the selected page on the dropdown 2014-11-25 12:44:26 +00:00
José Padilla
200e0b17da Clean up extra white space 2014-11-25 12:44:11 +00:00
José Padilla
361827350a Move content template into base.html 2014-11-25 12:44:11 +00:00
José Padilla
16d442dda3 Use MkDocs meta.source to render source code links 2014-11-25 12:44:11 +00:00
Dougal Matthews
d72a56f37f Move the docs theme out of the docs folder. 2014-11-25 12:43:42 +00:00
Dougal Matthews
5d479c20d8 Move nav to it's own template based on the MkDocs theme 2014-11-25 12:43:42 +00:00
Dougal Matthews
b443f81481 Add meta description 2014-11-25 12:43:42 +00:00
Dougal Matthews
6da9d5aee0 Add a workaround for not having the index name 2014-11-25 12:43:42 +00:00
Dougal Matthews
5600878672 Fixed the TOC (again)
Not sure how I broke it ;-)
2014-11-25 12:43:42 +00:00
Dougal Matthews
3c49b9fe46 Add next and previous page. 2014-11-25 12:43:42 +00:00
Dougal Matthews
49a493f61f Bring back the promo section 2014-11-25 12:43:42 +00:00
Dougal Matthews
18712a5cbc Fix the Navigation style 2014-11-25 12:43:42 +00:00
José Padilla
d6b203f013 Use page_title instead of title in docs theme 2014-11-25 12:43:02 +00:00
Dougal Matthews
2ddef2d326 Drop simply from the mkdocs install lines
It is still simple tho', honest ;)
2014-11-25 12:43:02 +00:00
Dougal Matthews
84d9c4b46e Change site_dir to html to match mkdocs.py 2014-11-25 12:42:39 +00:00
Dougal Matthews
261c4ce9af Remove redundant requirements file 2014-11-25 12:32:29 +00:00
Dougal Matthews
3a648b9f0b Migrate documentation to MkDocs proper 2014-11-25 12:32:29 +00:00
Tom Christie
3b40f8c1c1 Drop 0.x release notes 2014-11-25 12:15:48 +00:00
Tom Christie
83281254d1 Hypenate 'un-coerced' 2014-11-25 12:06:27 +00:00
Tom Christie
c4dff54ecc Docs on ValidationError 2014-11-25 12:04:46 +00:00
Tom Christie
a3c0c8fb90 Add missing period. 2014-11-25 12:04:35 +00:00
Tom Christie
2e726e22a3 request.DATA, request.FILES -> request.data 2014-11-25 11:42:43 +00:00
Marc
83e556ba1e Missing quotes on validate_score example 2014-11-25 12:37:20 +01:00
Tom Christie
3371131a61 Merge pull request #2116 from LuRsT/patch-5
Fixed database update instructions
2014-11-24 13:21:15 +00:00
Gil Gonçalves
918b9cc6a6 Added missing import in tutorial snippet 2014-11-24 08:54:07 +00:00
Gil Gonçalves
790a651893 Fixed database update instructions 2014-11-24 08:51:08 +00:00
Tony Nguyen
c94d1e6d3e Fix typo "serailizers" to "serializers" 2014-11-23 22:40:40 +07:00
Matthew Dapena-Tretter
8e940a22fb Clarify how permission classes are composed
all/every/AND or any/OR? all/every/AND!
2014-11-21 16:04:45 -05:00
Tom Christie
071c064d25 Fill in TODOs for 3.0 beta release notes 2014-11-20 14:22:53 +00:00
Tom Christie
6a2023a362 Note on 3.1 and 3.2 releases. 2014-11-20 13:52:00 +00:00
Tom Christie
096c58b784 Merge branch 'master' into 3.0-beta 2014-11-20 11:51:42 +00:00
Gil Gonçalves
04d2635b24 Removed unused import from code snippet in tutorial 2014-11-20 11:33:42 +00:00
Raony Guimarães
928cbc640e small type 2014-11-19 13:53:36 -02:00
Tom Christie
bc83dfece4 Merge branch 'master' into 3.0-beta 2014-11-19 14:04:31 +00:00
Tom Christie
51b7033e4a Further notes in 3.0 announcement 2014-11-19 14:03:19 +00:00
Tom Christie
f269826a7d Note on 3.0 beta 2014-11-18 16:26:45 +00:00
Tom Christie
5e74f02d61 Note removal of 'save_object' and fail loudly if it exists 2014-11-18 14:49:00 +00:00
Tom Christie
0f508c5821 Docs for advanced default argument usage. Closes #1945 2014-11-17 18:36:32 +00:00
José Padilla
d08cfb0559 Fix runtests examples
Correctly rename runtests examples to work with current runtests.py file.
2014-11-17 08:17:40 -04:00
Tom Christie
ea98de9b88 Model fields with .blank or .null now map to required=False. Closes #2017. Closes #2021. 2014-11-13 19:28:57 +00:00
Tom Christie
fd7db776ad Bring UniqueValidator implementation in line with other uniquness validators. 2014-11-10 12:32:03 +00:00
Tom Christie
8c1fa0b87d Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-11-10 12:21:41 +00:00
Tom Christie
f387cd89da Uniqueness constraints imply a forced 'required=True'. Refs #1945 2014-11-10 12:21:27 +00:00
Jochen Van de Velde
440d61ab36 Fix some typos and other errors 2014-11-08 11:02:48 +01:00
José Padilla
058fea23d3 Fix csrf-ajax link. Closes #2045 2014-11-07 23:55:42 -04:00
Tom Christie
93633c297c Tweaks to release notes 2014-11-07 20:44:12 +00:00
Tom Christie
59b30307e8 Fixes to release notes 2014-11-07 20:10:15 +00:00
Brett Koonce
b44def4650 minor spelling tweaks 2014-11-06 23:19:26 -08:00
Tom Christie
5250700659 Add docs on request.accepted_renderer and .accepted_media_type 2014-11-05 11:14:41 +00:00
Tom Christie
571440e143 Stronger calling out of 'DjangoObjectPermissionsFilter'. Closes #1934. 2014-11-05 10:53:46 +00:00
Sumana Harihareswara
7352405697 Updated book link in HATEOAS page
Per http://www.crummy.com/2013/10/03/0 , the new book is *RESTful Web APIs* and the old book, *RESTful Web Services*, is obsolete.
2014-11-04 17:18:13 -05:00
Tom Davis
3375fecc8b Fix typo
That's all.
2014-11-03 15:05:45 -05:00
Tom Christie
1925d465ae Call out 'get_value' and 'get_attribute' 2014-11-03 16:42:00 +00:00
Tom Christie
5d7b835608 Tweaks to validation notes 2014-11-03 16:17:53 +00:00
Tom Christie
09f3eedb23 Add notes re view-level and instance-level permissions checks. Closes #1819. 2014-11-03 15:23:16 +00:00
Tom Christie
78ac332f18 Add docs on Meta inheritance. Closes #1926. 2014-11-03 15:08:19 +00:00
Tom Christie
21d06a4103 Added NON_FIELD_ERRORS_KEY to serializer docs. Closes #1971. 2014-11-03 15:03:10 +00:00
Tom Christie
0da30e6d1d Add note about 3.0 being merged to master 2014-11-03 14:43:00 +00:00
Rocky Meza
9ce130d1b5 Fixed some typos in 3.0 release notes 2014-11-03 06:56:42 -07:00
Tom Christie
d27b8cc09b PUT as create docs, and move mixin out to external gist 2014-11-03 12:00:19 +00:00
Tom Christie
37845968cd Merge master 2014-11-03 11:39:54 +00:00
Tom Christie
96bb77dc35 Version 2.4.4 2014-11-03 11:20:18 +00:00
Andy Baker
964b3401fb typo fix 2014-11-01 10:25:59 +00:00
Tom Christie
0e59c27e2f Merge branch 'master' into version-3.0 2014-10-31 15:19:40 +00:00
Tom Christie
159c3de9fc Merge master 2014-10-31 15:19:15 +00:00
Tom Christie
254701230d Fix up validators docs 2014-10-31 13:58:40 +00:00
Tom Christie
2762205887 Validator documentation and tweaks 2014-10-31 13:47:36 +00:00
Andrew Conti
f25f05dde5 Update authentication.md
Based on the [new documentation](https://docs.djangoproject.com/en/dev/topics/auth/customizing/#django.contrib.auth.get_user_model) for Django 1.7 we should now use:

```python
@receiver(post_save, sender=settings.AUTH_USER_MODEL)
```
instead of:

```python 
@receiver(post_save, sender=get_user_model())
```
because `get_user_model()` only works once Django has imported all models. Otherwise you'll get: 

```python
django.core.exceptions.AppRegistryNotReady: Models aren't loaded yet.
```
When trying to start your sever after adding token authentication.

From the Docs, ( linked above as well ) :
>New in Django 1.7:
>When connecting to signals sent by the User model, you should specify the custom model using the AUTH_USER_MODEL setting.
2014-10-29 16:31:36 -04:00
Tom Christie
702f47700d Updated requirements 2014-10-24 12:12:01 +01:00
Tom Christie
c5d1be8eac .validate() can raise field errors or non-field errors 2014-10-22 10:32:32 +01:00
José Padilla
11edd01c34 Add docs regarding linking third party packages 2014-10-17 08:58:31 -04:00
Tom Christie
05cbec9dd7 Use serializers.ValidationError 2014-10-17 13:23:14 +01:00
Tom Christie
d0f610be44 Update release notes 2014-10-16 20:47:57 +01:00
konradhalas
5e89994a10 Add to main 3rd party resources list. 2014-10-16 15:16:13 +02:00
konradhalas
113a28ed8a Add djoser to authentication docs. 2014-10-16 13:48:18 +02:00
wolfe
f8f101268e Update 3.0-announcement.md
Swap order of custom field API changes so the two "and" clauses are in the same order.
2014-10-14 18:58:25 -03:00
Tom Christie
d8a8987ab1 Tweaks 2014-10-10 14:32:02 +01:00
Tom Christie
d9a199ca0d exceptions.ValidationFailed, not Django's ValidationError 2014-10-10 14:16:09 +01:00
Tom Christie
5d247a65c8 First pass on nested serializers in HTML 2014-10-09 15:11:19 +01:00
Tom Christie
babdc78e61 Typo 2014-10-09 11:39:01 +01:00
Tom Christie
6637b2fae0 Document the Metadata API 2014-10-09 11:08:26 +01:00
Tom Christie
a58cfe167d Update tutorial for 3.0 2014-10-09 09:38:03 +01:00
Tom Christie
4c015df28c Tweaks 2014-10-08 16:43:33 +01:00
Tom Christie
14ae52a24e More gradual deprecation 2014-10-08 16:09:37 +01:00
Tom Christie
0cbb57b40f Tweak pre/post save hooks. Return instance in .update(). 2014-10-08 12:17:30 +01:00
Kevin London
0803716ed0 Update links in 2.4-announcement.md
The links to Django Rest Framework pages were 404ing because the URLs include a slash.
2014-10-04 17:34:27 -07:00
Tom Christie
3a3e2bf57d Serializer.save() takes keyword arguments, not 'extras' argument 2014-10-03 13:42:06 +01:00
Craig de Stigter
857a8486b1 More spelling tweaks 2014-10-03 09:00:33 +13:00
Craig de Stigter
dfab9af294 Minor: fix spelling and grammar, mostly in 3.0 announcement 2014-10-03 08:41:18 +13:00
Omer Katz
770d63fb04 Fixed documentation typo. 2014-10-01 13:12:33 +03:00
Tom Christie
da4900a353 Update 3.0-announcement.md 2014-09-30 11:10:13 +01:00
Tom Christie
83a5ea8db2 Update release notes 2014-09-29 21:17:13 +01:00
Tom Christie
a8622adcd9 Update index.md 2014-09-29 16:57:40 +01:00
Tom Christie
657d1de032 Latest release notes 2014-09-29 14:12:09 +01:00
Tom Christie
4798df52df Update release notes 2014-09-29 12:57:05 +01:00
Tom Christie
ce04d59a53 Update release notes 2014-09-26 17:07:47 +01:00
Tom Christie
ac71d9aaae Merge master 2014-09-26 14:39:20 +01:00
Tom Christie
ee79b45397 Prepend some pre-release notes 2014-09-26 13:19:32 +01:00
Tom Christie
24f7db2fc1 Release notes 2014-09-26 13:12:10 +01:00
Tom Christie
0eb6a4de8a Release notes 2014-09-26 13:10:58 +01:00
Tom Christie
8b8623c5f8 Allow many, partial and context in BaseSerializer 2014-09-26 12:48:20 +01:00
Tom Christie
fde934d33c Release notes 2014-09-26 12:21:05 +01:00
Tom Christie
90311357ad Release notes 2014-09-26 12:18:27 +01:00
Tom Christie
e8af73d144 Release notes 2014-09-26 12:17:20 +01:00
Tom Christie
43e80c74b2 Release notes 2014-09-26 11:56:29 +01:00
Tom Christie
2859eaf524 request.data attribute 2014-09-26 10:46:52 +01:00
Tom Christie
630d472055 Merge branch 'master' into version-3.0 2014-09-24 14:10:00 +01:00
Collin Anderson
da385c9c1f remove patterns and strings from urls #1898 2014-09-23 17:10:02 -04:00
Tom Christie
c0150e619c Add BaseSerializer heading 2014-09-19 14:59:59 +01:00
Tom Christie
8495cd898a Drop 'No major point releases are currently planned.', cos they are. 2014-09-19 14:31:28 +01:00
Tom Christie
20424251a3 Version 2.4.3 2014-09-19 14:26:28 +01:00
Tom Christie
88008c0a68 Merge branch 'master' into version-3.0 2014-09-19 14:05:50 +01:00
Tom Christie
6d73b5969a Initial release notes 2014-09-19 14:02:17 +01:00
Matthew J Morrison
764366b2e1 Fixed code formatting 2014-09-17 11:29:15 -05:00
Matthew J Morrison
e5af0bbb35 Clarify "raised inside REST framework"
I ran into an issue today where I was not seeing the rest_framework.views.exception_handler do what I thought it should be doing. It turned out that I had imported View from rest_framework.views rather than importing APIView from rest_framework.views. The phrase "raised inside REST framework" was confusing as I was debugging this issue. I was unsure if that meant that I could raise those exceptions in my code or if it had to originate from within framework code.

I'm not sure if the proposed wording is ideal, I just wanted to point out what I found to be confusing.
2014-09-17 07:49:54 -05:00
S. Andrew Sheppard
3725a1e77d add wq.db router and django-rest-pandas renderers 2014-09-15 14:46:09 -05:00
Tom Christie
cefeb23b25 Merge pull request #1871 from jpadilla/third-party-docs
Add Third Party Resources Topic section
2014-09-14 16:52:53 +01:00
José Padilla
915dfb9b3d Update third-party-resources.md 2014-09-14 10:19:54 -04:00
José Padilla
4871dbdc73 Add invitation to add new content 2014-09-13 16:20:37 -04:00
José Padilla
96c21b81f5 Add Third Party Resources Topic section 2014-09-13 13:53:40 -04:00
Tom Christie
4fceceae7d DecimalField documentation 2014-09-12 20:09:08 +01:00
Tom Christie
f95e7fae38 Updating docs 2014-09-12 12:40:53 +01:00
Tom Christie
19b8f779de Throttles now use Retry-After header and no longer support the custom style 2014-09-11 20:43:44 +01:00
Tom Christie
de301f3b66 Merge master 2014-09-11 13:20:44 +01:00
S. Andrew Sheppard
e76f56a3d6 add django rest pandas 2014-09-10 11:55:43 -05:00
Darren Maki
fe06d96dec Fixing quotes in filtering.md
Incorrect quotes used in examples.
2014-09-07 12:53:21 -04:00
Tom Christie
f08afe162c Version 2.4.2 2014-09-03 16:35:17 +01:00
Tom Christie
55e779c856 Version 2.4.1 2014-09-01 09:07:55 +01:00
Tom Christie
5490fc2700 Fix links in 2.4 release 2014-08-29 13:29:51 +01:00
Jamie Matthews
baceb528cb Fix typos in 2.4 release notes 2014-08-29 11:11:18 +01:00
Tom Christie
0f8fdf4e72 Remove allow_empty.
Closes #1774.
2014-08-29 10:57:24 +01:00
Tom Christie
d8eb9e6d45 Docs whitespace fix. 2014-08-29 10:48:16 +01:00
Tom Christie
572107281f Typo in 2.4 announcement name 2014-08-29 10:15:55 +01:00
Tom Christie
2a61ed8bac 2.4 Release notes 2014-08-29 10:10:17 +01:00
Tom Christie
8f4ae06b3b Merge pull request #1784 from tomchristie/remove-model-attribute
Deprecate `.model` attribute on views
2014-08-29 10:03:07 +01:00
Tom Christie
bb1604674f Minor docs update 2014-08-29 09:21:10 +01:00
Tom Christie
e7e3d29de4 Sponsor fix 2014-08-28 17:35:45 +01:00
Tom Christie
2536b93c03 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-08-28 17:02:37 +01:00
Tom Christie
73bd408f78 Latest sponsor update 2014-08-28 17:01:58 +01:00
Nathan Hubbell
be21cafd2b Update generic-views.md
Small grammar changes.
2014-08-27 17:57:40 -07:00
Nathan Hubbell
19076510f4 Update generic-views.md 2014-08-26 17:31:08 -07:00
Carlton Gibson
c29c75da28 Merge pull request #1789 from nemesisdesign/patch-5
docs: added drf-hstore to third party fields
2014-08-26 11:19:48 +02:00
Federico Capoano
eb81c55d16 docs: added HStoreSerializer to third party serializers
added a reference to django-rest-framework-hstore in docs/api-guide/serializers.md
2014-08-25 12:32:44 +02:00
Federico Capoano
8e3f7700f6 docs: added drf-hstore to third party fields
added a reference to django-rest-framework-hstore in docs/api-guide/fields.md
2014-08-25 12:29:10 +02:00
Tom Christie
8b2052172c Add .model deprecation to release notes 2014-08-21 12:25:20 +01:00
Tom Christie
21a0a826bb Add Retry-After to release notes. Refs #1508. 2014-08-20 17:34:51 +01:00
Tom Christie
6953a5ecec Typo 2014-08-20 17:16:47 +01:00