Commit Graph

2303 Commits

Author SHA1 Message Date
Quentin Pradet
a5506610ad Put the needed import in one example 2015-03-20 15:17:49 +01:00
Quentin Pradet
8ba66e2c10 Document per-view versioning settings
That is, document the default_version, allowed_version and version_param
class variables.
2015-03-20 15:06:30 +01:00
Xavier Ordoquy
164be174ea Release notes for 3.1.1 and version bump. 2015-03-19 23:29:10 +01:00
Aaron Yong
000db8df18 Fix typo in versioning docs 2015-03-17 11:36:02 -06:00
Tom Christie
2e55d15d4d Merge pull request #2703 from kylepjohnson/master
Add necessary imports to final urls.py example
2015-03-16 15:33:00 +00:00
Kyle P. Johnson
d655a423fb Add necessary imports to final urls.py example 2015-03-16 11:17:02 -04:00
Rubén Durá Tarí
ac44bae90d Updates ducumentation DEFAULT_PAGE_SIZE left over after #2655 2015-03-16 14:53:26 +00:00
Xavier Ordoquy
a02098b855 Fix the link to the old doc (#2681). 2015-03-13 00:15:53 +01:00
Esmail
2484dbf4e1 Fix example of explicit format URL (for real).
Do what I meant to do in #2670:

The link is displayed in the tutorial as "http://example.com/api/items/4.json" but the hyperlink itself and what the example code actually works with are (in my opinion, less pretty) URLs like "http://example.com/api/items/4/.json".
2015-03-11 12:00:19 -04:00
James Rutherford
7854c939dd Fixed import statement in API docs 2015-03-11 10:44:42 +00:00
Bryan Alsdorf
69b6e26f06 Changed incorrect class name 2015-03-10 17:30:41 -05:00
Xavier Ordoquy
3e44f788b1 Fixed a typo in the documentation's link. 2015-03-09 17:28:00 +01:00
Tom Christie
e520ea0acb Merge pull request #2652 from jpadilla/master
Remove the 'docs for 3.0' banners.
2015-03-09 08:53:13 +00:00
Tom Christie
d46d860088 Merge pull request #2655 from jwbixby/patch-1
Update documentation over PAGE_SIZE
2015-03-09 08:50:29 +00:00
Deven Xie
20ba47e343 Fixed missing word in CursorPagination docs 2015-03-09 00:10:26 -04:00
jwbixby
c2cbda43b9 Update documenation over PAGE_SIZE
This replaces all locations of the old setting `DEFAULT_PAGE_SIZE` for the current setting `PAGE_SIZE`
2015-03-08 00:22:28 -05:00
José Padilla
140b94c32e Update to 3.1 release 2015-03-07 10:50:31 -04:00
José Padilla
d12de927ad Remove docs for 3.0 banners 2015-03-07 10:49:56 -04:00
José Padilla
2ddb6bfa70 Fix permissions on markdown files 2015-03-07 10:19:25 -04:00
José Padilla
d2181cc74c Fix customizing field mappings link 2015-03-06 09:41:34 -04:00
Tom Christie
7efb2fd9ed Better docs linking 2015-03-06 12:26:09 +00:00
Tom Christie
c511342047 More docs on cursor pagination 2015-03-06 11:32:03 +00:00
Tom Christie
58dfde7fcd Tweaks for cursor pagination and docs 2015-03-06 10:22:32 +00:00
Tom Christie
efb42ff7d0 Update docs 2015-03-04 16:17:30 +00:00
Tom Christie
18cc0230bf Clean up pagination attributes 2015-03-04 15:51:00 +00:00
Aider Ibragimov
c20a0250df add FilePathField, update docs 2015-03-03 14:34:06 +03:00
Aider Ibragimov
de72022f80 Merge branch 'master' of https://github.com/Ins1ne/django-rest-framework into feature/ipaddress 2015-02-28 14:29:27 +03:00
Aider Ibragimov
4d5eee04a0 add IPAddressField, update docs 2015-02-28 10:11:38 +03:00
José Padilla
700af5dab2 Merge pull request #2584 from aRkadeFR/DocFixingTypo
Documentation test fix double word
2015-02-27 12:53:10 -04:00
aRkadeFR
9c359181d7 update for that the instead of that 2015-02-27 17:38:28 +01:00
Tom Christie
dafc045c2d Merge pull request #2606 from tomchristie/1.8-beta
Formally upgrade suport to Django 1.8-beta
2015-02-26 13:49:44 +00:00
Tom Christie
8f988466a5 Docs on exception handler context. Closes #2604. 2015-02-26 13:20:26 +00:00
Tom Christie
e72428214c Formally upgrade suport to Django 1.8-beta 2015-02-26 12:53:24 +00:00
Tom Christie
03818ed004 Pagination tweaks and docs 2015-02-26 12:48:34 +00:00
Mateusz Sikora
b92d6df66a Update third-party-resources.md 2015-02-25 18:53:33 +01:00
Mateusz Sikora
e51dc1855c Update authentication.md 2015-02-25 18:51:20 +01:00
Mateusz Sikora
71619a02c5 Update third-party-resources.md 2015-02-25 17:58:54 +01:00
ludbek
f29b657798 updated outdated link at testing.md#APIClient 2015-02-21 07:52:56 +05:45
aRkadeFR
c0916c2859 Documentation test fix double word 2015-02-20 15:59:10 +01:00
Paul Hallett
d9c652813d add missing import in tests 2015-02-18 15:53:57 +00:00
Yannick PÉROUX
30e6f32f6f Fix typo in requests.md 2015-02-17 17:08:30 +01:00
Tom Christie
f1e517449a Minor docs tweak 2015-02-17 13:41:59 +00:00
Tom Christie
691ae5b646 Recommend 'pip list --outdated' instead of using pip-review 2015-02-17 13:40:59 +00:00
Tom Christie
028c477c22 Note on using pip-review in docs. 2015-02-17 12:56:19 +00:00
Tom Christie
4248a8d3fc Merge pull request #2198 from tomchristie/version-3.1
Version 3.1
2015-02-13 13:38:44 +00:00
Tymur Maryokhin
9d80335ac8 Remove '.model' shortcut from viewset docs. Refs #2486. Closes #2549. 2015-02-12 01:10:03 +01:00
Xavier Ordoquy
f6033cee87 Add release notes for 3.0.5. 2015-02-10 22:46:54 +01:00
donewell
9ea615af14 add message to custom permission
change detail to message and update text
2015-02-10 20:11:53 +00:00
Joar Leth
b18d773b51 Fix typo in 3.1 announcement 2015-02-09 22:51:49 +01:00
Tom Christie
fbb21caaaa Merge master 2015-02-09 20:43:50 +00:00
Tom Christie
407480b484 Minor docs work 2015-02-09 17:01:41 +00:00
Tom Christie
670723f021 Minor cleanups/improvements to ModelSerializer API 2015-02-06 15:45:02 +00:00
José Padilla
235b98e427 Merge pull request #2460 from mmarvick/master
Small fixes to the tutorial
2015-02-06 11:31:25 -04:00
Tom Christie
5d8c3abe72 Fix typo 2015-02-06 15:27:35 +00:00
Tom Christie
a435b1b355 Merge branch 'version-3.1' of git://github.com/jpadilla/django-rest-framework into version-3.1 2015-02-06 14:39:31 +00:00
Tom Christie
1f99612845 Upgrade pending deprecations to deprecations 2015-02-06 13:21:35 +00:00
Tom Christie
1d4956f616 Pagination images 2015-02-06 13:08:04 +00:00
Tom Christie
53716f6152 Internationalization docs 2015-02-06 11:37:29 +00:00
José Padilla
7f801b9a01 Add trim_whitespace to CharField #2517
If set to `True` then leading and trailing
whitespace is trimmed. Defaults to `True`.
2015-02-06 01:09:19 -04:00
Michael Marvick
5bf803b6ed Revert some of the changes made in 1-serialization.md 2015-02-05 19:42:36 -08:00
Tom Christie
09488ad4da Link to ModelSerializer API 2015-02-06 00:25:03 +00:00
Tom Christie
6c63ef13cd Drop 2.x announcements 2015-02-06 00:04:20 +00:00
Tom Christie
41b213414d Updating release notes 2015-02-04 23:32:25 +00:00
Xavier Ordoquy
46181341d5 Merge pull request #2512 from heywbj/docs
Add django-rest-framework-recursive to docs
2015-02-04 00:13:52 +01:00
Warren Jin
76efbdddb6 docs 2015-02-03 17:18:54 -05:00
James Cooke
f676569661 Small documentation fixes
* Remove "you you" from viewsets API-guide
* Fix link from routers API-guide to viewsets API-guide
2015-02-03 13:43:03 +00:00
Tom Christie
d015534d53 Fleshing out 3.1 announcement 2015-02-03 09:15:42 +00:00
Tom Christie
6e2ea852d0 Merge pull request #2498 from dustinfarris/update-eda-link
Update link for ember-django-adapter
2015-02-01 21:17:36 +00:00
Dustin Farris
2111a99b32 Update link for ember-django-adapter 2015-02-01 16:00:24 -05:00
José Padilla
9437d9b8ee Fix base_template name in example 2015-02-01 16:18:40 -04:00
José Padilla
aaa1fcd5d1 Fixes #2493 2015-02-01 16:18:02 -04:00
Tom Christie
2cc4cb2465 Fix error text in test. 2015-01-31 08:53:40 +00:00
Tom Christie
0d96cf2ca2 Latest translation source messages. 2015-01-30 16:27:49 +00:00
Tom Christie
4ee4b4f2dc Merge master 2015-01-30 14:00:25 +00:00
Tom Christie
7cf9dea7f9 Docs typo. Closes #2491. 2015-01-30 11:00:29 +00:00
Tymur Maryokhin
e720927b78 Removed deprecated '.model' docs 2015-01-29 17:28:18 +01:00
mareknaskret
4a2a36ef82 Update filtering.md
Updated links for django-guardian package.
2015-01-28 15:17:56 +01:00
Xavier Ordoquy
0daf160946 Fix #2476 2015-01-28 00:06:34 +01:00
Xavier Ordoquy
925ea4bdc6 Release notes for 3.0.4 2015-01-27 19:43:38 +01:00
Tom Christie
fc70c0862f Galileo Press -> Rheinwerk Verlag 2015-01-26 14:07:21 +00:00
Michael Marvick
73bd0d539f tutorial #5 incorrectly referenced 'settings.py' instead of 'tutorial/settings.py' 2015-01-25 23:47:01 -08:00
Michael Marvick
2a6937f381 tutorial #2 incorrectly showed /item.json instead of /item/.json for format suffixes 2015-01-25 23:46:27 -08:00
Michael Marvick
90c9968a70 tutorial #1 incorrectly showed string of json instead of ReturnDict type from 'serializer.data', and also has a third item in the second usage 2015-01-25 23:45:56 -08:00
Jeff Fein-Worton
0a65913fea typo in fields.md 2015-01-24 18:34:16 -08:00
Jeff Fein-Worton
39da9c7c86 minor typo in viewsets docs 2015-01-24 12:53:21 -08:00
Tom Christie
8f6d7f4a5a Merge pull request #2451 from tomchristie/dict-field
Added DictField and support for HStoreField.
2015-01-23 16:33:37 +00:00
Tom Christie
35f6a82462 Added DictField and support for HStoreField. 2015-01-23 16:27:23 +00:00
Tom Christie
b07d931261 Merge pull request #2448 from tomchristie/uuid-field
Added UUIDField.
2015-01-23 15:43:21 +00:00
Tom Christie
5bb348605e UUIDField docs 2015-01-23 15:31:08 +00:00
Tom Christie
39f26c9eca Merge master 2015-01-23 14:28:59 +00:00
Carlton Gibson
790c92d438 Update Django-Filter references in docs and requirements. 2015-01-23 15:22:20 +01:00
Duncan Maitland
6e471ad8f4 fix link to Django CSRF docs 2015-01-22 18:29:20 +11:00
Tom Christie
9ec08ce578 Merge master 2015-01-21 13:12:14 +00:00
soooooot
3ca8f85a5b correcting unclosed quote in routers.md
correcting unclosed quote in routers.md
2015-01-20 22:24:58 +08:00
Eric Theise
b0bc79ed4d correcting "it's" to "its" in Tutorial 1 2015-01-19 14:49:36 -08:00
Tom Christie
6065cdbd93 Merge master 2015-01-19 15:16:57 +00:00
Tom Christie
53edd37df5 Tests for LimitOffsetPagination 2015-01-15 21:07:05 +00:00
Tom Christie
313aa727e3 Tweaks 2015-01-14 17:46:41 +00:00
Tom Christie
1bcec3a0ac API tweaks and pagination documentation 2015-01-13 17:14:13 +00:00
Tom Christie
564f845e21 Lower header font weights for nicer docs style 2015-01-13 12:21:03 +00:00
Tom Christie
8e2dc6b26d Update internationalization docs 2015-01-13 12:07:25 +00:00
Tom Christie
2b28026fc1 Translation info -> project management 2015-01-13 10:44:40 +00:00
Carlton Gibson
41e13d73fa Merge pull request #2407 from philipn/filters_link_fix
Fix link to `django-rest-framework-filters`
2015-01-13 09:04:33 +01:00
Philip Neustrom
7f9a62a5bf Fix link to django-rest-framework-filters (formerly
`django-rest-framework-chain`)
2015-01-13 15:22:08 +08:00
Tom Christie
605c1fa0a8 Merge pull request #2397 from travelton/TweakTutorialDocs
Tweaked a few issues in the tutorial documentation.
2015-01-10 14:07:13 +00:00
Travis Swientek
8ccf5bcc0b Tweaked a few issues in the tutorial documentation. 2015-01-09 11:36:21 -08:00
Tom Christie
11efde8905 Merge pull request #2373 from jakul/document-translations-3.1
Document how to translate DRF error messages (version 3.1)
2015-01-09 11:57:02 +00:00
Xavier Ordoquy
ef16c546d7 Update the release note with latest fixes.
Add the link to the 3.0.3 milestone.
2015-01-08 23:29:51 +01:00
Xavier Ordoquy
02ee3871ae Merge remote-tracking branch 'origin/master' into release/3.0.3 2015-01-08 23:24:19 +01:00
Tom Christie
42c913334b Minimum 1.6.x version is 1.6.3 2015-01-08 14:51:08 +00:00
Tom Christie
f529f83d3c Minimum Django 1.5 version issue 1.5.6 2015-01-08 14:38:23 +00:00
Tom Christie
f0ad0a88c4 Link to Roy Fielding versioning interview. 2015-01-08 12:31:51 +00:00
Tom Christie
3dbcefb3c7 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2015-01-08 11:07:52 +00:00
Tom Christie
e61ef3d39f Minor docs updates 2015-01-08 11:07:47 +00:00
Tom Christie
18cefad3ab Update project-management.md 2015-01-07 21:03:50 +00:00
Tom Christie
1102e22cb4 Update project-management.md 2015-01-07 21:02:42 +00:00
Xavier Ordoquy
42f1932b52 Release notes for 3.0.3 2015-01-07 19:10:22 +01:00
Craig Blaszczyk
7913947757 add config and documentation about uploading/downloading translations from Transifex 2015-01-07 11:13:03 +00:00
JocelynDelalande
fe92a2cfee fixed doc : DEFAULT_AUTHENTICATION_CLASSES -> DEFAULT_AUTHENTICATION
+ It is consistent with docs about DEFAULT_PERMISSION_CLASSES
2015-01-07 10:42:11 +01:00
Tom Christie
271b638df1 Update exception docs. Closes #2378. 2015-01-06 11:21:58 +00:00
Tom Christie
d3b2302588 Minor docs update. Refs #2375. 2015-01-05 16:31:52 +00:00
Tom Christie
949e3b7507 Merge branch 'master' into version-3.1 2015-01-05 15:04:23 +00:00
Tom Christie
b6ca7248eb required=False allows omission of value for output. Closes #2342 2015-01-05 14:32:12 +00:00
Tom Christie
17665aa52a Add docs for OAuth, XML, YAML, JSONP packages. Closes #2179. 2015-01-05 12:26:15 +00:00
Tom Christie
6168f60ba8 Merge branch 'master' into version-3.1 2015-01-05 11:02:28 +00:00
Craig Blaszczyk
9f169acb62 capitalise Django 2015-01-02 11:08:45 +00:00
Craig Blaszczyk
0b8a83bd62 update internationalisation instructions to prevent symlinking; add base .po file 2015-01-02 11:08:04 +00:00
Craig Blaszczyk
2781903a5a Add info about how django chooses which language to use 2015-01-02 11:07:58 +00:00
Craig Blaszczyk
7ad7dd6a42 match DRF style guide 2015-01-02 11:07:49 +00:00
Craig Blaszczyk
309b5d2641 instructions on how to translate REST framework error messages 2015-01-02 11:07:35 +00:00
Rob Terhaar
336faf5a86 fix widget style formatting 2015-01-01 21:01:16 -05:00
Tom Christie
5d8c45681a Update copryright for 2015. Closes #2247. 2014-12-28 18:48:42 +00:00
Tom Christie
d8e66970a1 Note on using i18n_patterns with format_suffix_patterns. Closes #2278. 2014-12-28 12:14:07 +00:00
Tom Christie
8dc95ee221 Add notes on include and namespacing. Closes #2335. 2014-12-28 11:24:49 +00:00
Tom Christie
27f84aa0f3 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-28 11:02:36 +00:00
Tom Christie
a636320ff3 Add import notes in docs. Closes #2357 2014-12-28 11:02:19 +00:00
Rocky Meza
5b5652594a Typo manger => manager 2014-12-26 22:24:31 -07:00
Tom Christie
00531ec937 Release notes on non-text detail arguments. Closes #2341. 2014-12-26 15:48:16 +00:00
Matías Lang
18687f075d Documented an optional argument of HyperlinkedIdentityField
lookup_url_kwarg argument of HyperlinkedIdentityField wasn't documented
2014-12-23 12:22:10 -03:00
Brian Stearns
3569674860 use of double quotes broke the code highlighting. 2014-12-21 18:53:35 -05:00
Tom Christie
2a1485e009 Final bits of docs for ModelSerializer fields API 2014-12-19 21:32:43 +00:00
Tom Christie
48d15f6ff8 Stub out the documentation 2014-12-19 16:58:35 +00:00
Tom Christie
d109ae0a2e Merge pull request #2010 from tanwanirahul/master
Ability to customize method names without creating a custom router
2014-12-19 16:09:01 +00:00
Rahul
8f0fef4b75 Updated documentation on url_path per suggestions. 2014-12-19 21:22:10 +05:30
Rahul
b4a3e7f640 Updates url_path info per suggestion 2014-12-19 21:20:19 +05:30
Rahul
6aa0e307c9 Added documentation about url_path parameter for custom actions. 2014-12-19 20:31:21 +05:30
tanwanirahul
a8a3fedb5c Add url_path documention for detail_route decorator 2014-12-19 20:16:46 +05:30
Tom Christie
435aef7738 Merge branch 'master' into version-3.1 2014-12-19 11:53:05 +00:00
Tom Christie
7105c1308e Add OPTIONS/metadata to docs index 2014-12-18 15:42:27 +00:00
Tom Christie
9c9d5bd859 Added project management docs. 2014-12-18 13:35:42 +00:00
Tom Christie
c8d88c8c8a Merge branch 'master' into version-3.1 2014-12-18 11:21:25 +00:00
Brent O'Connor
7e9aac98fe The pre_save method no longer works. This resolved issue #2306 2014-12-17 16:54:04 -06:00
Tom Christie
c87e95c239 Add missing date 2014-12-17 21:11:06 +00:00
Tom Christie
15c2001de0 Merge pull request #2297 from tomchristie/version-3.0.2
Version 3.0.2
2014-12-17 21:04:08 +00:00
Brent O'Connor
4f33cfe1a0 With httpie 0.8.0 the HTTP method has to come after the auth argument. 2014-12-17 14:38:01 -06:00
Tymur Maryokhin
eeb6e34064 Docs/tutorial import fixes. Refs #2296 2014-12-17 17:28:11 +01:00
Tom Christie
418108632c Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 16:23:20 +00:00
Tom Christie
90b8f9221e Use six.BytesIO in tutorial. Closes #2296. 2014-12-17 16:23:00 +00:00
Tom Christie
5f933f575e Merge pull request #2298 from epicserve/fix_typo
Fixed a typo
2014-12-17 16:20:22 +00:00
Brent O'Connor
530f7a21b3 Fixed a typo 2014-12-17 10:19:15 -06:00
Tom Christie
265ed9377e Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 16:19:13 +00:00
Tom Christie
c9a2ce0703 Expand permissions docs. Closes #2223. 2014-12-17 16:19:02 +00:00
Tom Christie
2adfb6c3aa Cleanup extra newline 2014-12-17 16:00:49 +00:00
Tom Christie
bbd55fafc5 Version 3.0.2 2014-12-17 15:58:30 +00:00
Tom Christie
ad6533e554 Merge pull request #2294 from tomchristie/fix-empty-html-values-with-default
Fix empty HTML values when a default is provided.
2014-12-17 15:24:01 +00:00
Tom Christie
ffc099a256 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 15:22:40 +00:00
Tom Christie
1ba822010d Highlight trailing '.' in command so it wont be missed. 2014-12-17 15:22:27 +00:00
Tom Christie
3fff5cb6e0 Fix empty HTML values when a default is provided. 2014-12-17 15:13:48 +00:00
Tom Christie
c6137bbf5a Serializer API restrictions. 2014-12-17 14:14:51 +00:00
Tom Christie
05a6eaec8a More docs, plus 'ALLOWED_VERSIONS' setting. 2014-12-17 12:41:46 +00:00
Tom Christie
6e51e4f5cd Versioning first pass 2014-12-16 15:34:19 +00:00
José Padilla
d71ef9c6d8 Closes #2281 2014-12-15 21:48:31 -04:00
Tom Christie
b6ee784240 Merge master 2014-12-15 12:18:55 +00:00
Jason Spafford
56c09cc1f2 Doc typo 2014-12-15 02:41:39 -08:00
Jason Spafford
b951c74df2 Made docs consistent 2014-12-15 01:24:12 -08:00
Tom Christie
d232c5739e Merge branch 'exception-handler-context' of git://github.com/jpadilla/django-rest-framework into version-3.1 2014-12-15 09:19:53 +00:00
Tom Christie
4778463e32 Merge branch 'master' into version-3.1 2014-12-15 09:18:11 +00:00
José Padilla
478c8d724b Update docs 2014-12-14 10:16:52 -04:00
Brian Jacobel
2d470eef80 Change serializers.Field to serializers.ReadOnlyField for 3.x compatibility
Using this code snippet as-is on DRF 3.0.1 results in a NotImplementedError
being raised for to_representation due to 3.0's changed behavior with
serializers.Field. The code snippet should be updated to use
serializers.ReadOnlyField instead.

Further discussion here:
https://groups.google.com/forum/?fromgroups=#!topic/django-rest-framework/aX8mLT_v3yc
2014-12-13 14:47:11 -05:00
Jeff Fein-Worton
00da241482 documentation typo
base-name -> base_name
2014-12-12 22:14:22 -08:00
Tom Christie
baaa356489 Merge master 2014-12-12 15:37:43 +00:00
Tom Christie
73a80564e2 Merge pull request #2251 from linovia/version/3.0.1
Release notes & version 3.0.1
2014-12-11 15:08:07 +00:00
Xavier Ordoquy
9c37174768 Fix the ghost backtick. 2014-12-11 15:58:02 +01:00
Xavier Ordoquy
3a69182cc9 Better link representation for the issues. 2014-12-11 15:32:52 +01:00
Xavier Ordoquy
75acdc93bc Fix the milestone link again. 2014-12-11 15:13:15 +01:00
Xavier Ordoquy
99423defd8 Add full stop to the release note items.
Add link to the issues
Fix the milestone link
2014-12-11 15:11:37 +01:00
Xavier Ordoquy
9a7b0755eb Add links to the issue id. 2014-12-11 15:06:10 +01:00
Xavier Ordoquy
ab801bb01f Release note corrections 2014-12-11 14:57:26 +01:00
Tom Christie
9b88b5db69 Field->ReadOnlyField in tutorial docs 2014-12-11 09:54:55 +00:00
Xavier Ordoquy
0188ca7306 Release notes for 3.0.1 2014-12-11 00:02:13 +01:00
Tom Christie
8ad0b83148 Minor docs tweaks 2014-12-10 14:29:21 +00:00
Tom Christie
01bb85e80a Merge pull request #2246 from d0ugal/mkdocs-theme
Syntax highlighting
2014-12-10 14:22:00 +00:00
Dougal Matthews
5fe5a93644 Move remaining sponsor 2014-12-10 14:09:47 +00:00
Dougal Matthews
1ea84c92a7 Sorted the images
Moved images referenced by the markdown back to the docs directory
Deleted unused image autocomplete.png
2014-12-10 13:59:51 +00:00
Tom Christie
dafc5d45a0 Minor docs tweaks to titles and citations 2014-12-10 12:28:48 +00:00
Dougal Matthews
9883862576 Move the static content into the docs theme 2014-12-10 11:34:26 +00:00
Tom Christie
76956beab4 snippets relationship in tutorial should be read_only 2014-12-09 19:53:27 +00:00
Tom Christie
f5b783af61 allow_blank in ChoiceField. Refs #2239. 2014-12-09 14:21:31 +00:00
Tom Christie
cae19f8924 Minor docs tweaks 2014-12-09 13:21:10 +00:00
Tom Christie
4cdfb6adc2 Add REST framework: Under the hood. video to the 3.0 announcement. 2014-12-09 13:18:18 +00:00
Tom Christie
af3fe5a39f Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-08 16:38:29 +00:00
Tom Christie
4e9ebb5fe9 cd back to parent directory 2014-12-08 16:38:17 +00:00
Tom Christie
302ec59a5c Merge pull request #2165 from phalt/httpie-examples
Use httpie for tutorials
2014-12-08 15:51:19 +00:00
phalt
f3ebac061e one last tabs / spaces! 2014-12-08 15:47:49 +00:00
phalt
8e9408115d fixed indentations 2014-12-08 15:41:01 +00:00
Tom Christie
fd02d8266b Added 3.0 to release notes. 2014-12-08 15:16:33 +00:00
José Padilla
8ba4e7bafe Add misc note about localization 2014-12-08 09:18:37 -04:00
Mark Henwood
9b468fba60 Amend ViewSet docs to warn of potential problem
I went through this exact problem and so thought the docs might
benefit from a small hint at the appropriate point.
2014-12-07 12:02:43 +00:00
Xavier Ordoquy
e4820d611b Fix the new Django default db name
PrimaryKeyRelatedField now needs a queryset argument.
urls now don't use urlpatterns.
2014-12-06 10:58:17 +01:00
Tom Christie
59b2ad5425 Minor docs tweaks 2014-12-05 13:23:14 +00:00
Tom Christie
e2587c7b4d Merge pull request #2204 from carltongibson/default-docs-fix
Clarify read-only & `unique_together` Documentation
2014-12-05 13:20:16 +00:00
Tom Christie
9fb1b396db user in example should have been instance. Closees #2191. 2014-12-05 13:07:31 +00:00
Tom Christie
b7b0fd3e14 Added .validated_data usage. Closes #2214. 2014-12-05 12:48:12 +00:00
Tom Christie
1b8c06aefe Style tweaks in examples 2014-12-05 12:46:08 +00:00
Tom Christie
e2b3908834 Fix quickstart tutorial 2014-12-05 09:44:01 +00:00
Xavier Ordoquy
9d078be59c Fix the tutorial against the v3.0 2014-12-04 23:34:55 +01:00
Xavier Ordoquy
38e05e66c9 print() function works from Python 2.6 to 3.X 2014-12-04 23:22:00 +01:00
Carlton Gibson
6ee361332b Add missing definite article 2014-12-04 14:15:01 +01:00
phalt
fcbae5d99f updates based on suggestions 2014-12-04 11:20:33 +00:00
Carlton Gibson
71e1a3942e Initial link from Serializers to Validators 2014-12-04 12:15:14 +01:00
Tom Christie
3d6620c72a Merge 2014-12-03 23:24:06 +00:00
Tom Christie
f74e52b31e Merge 2014-12-03 23:14:58 +00:00
Tom Christie
6369f92125 Merge 2014-12-03 23:12:52 +00:00
Martin Tschammer
ab25d706c7 Renamed validated_attrs to validated_data to be more in line with other similar code. 2014-12-03 23:52:35 +01:00
eiriksm
74a9ece3dc Update build status icon on github pages page. 2014-12-03 13:37:56 +01:00
phalt
a17d5d2b0b remove unsused link 2014-12-02 16:11:43 +00:00
Matías Lang
5ad22aea60 Updated serializers documentation
There was an error in the docs: the field extra_field_kwargs of the serializer's Meta doesn't work. The field must be extra_kwargs instead.
2014-12-02 12:23:25 -03:00
David Ray
84cff98fbf fix typo 2014-12-02 09:46:43 -05:00
phalt
515060a6ab Only show pip install for httpie 2014-12-02 10:16:41 +00:00
Tom Christie
6ac79b8223 Document Field.fail(). Closes #2147. 2014-12-02 09:19:59 +00:00
Tom Christie
f4fc4670ca Promote 'many_init' to public API. Closes #2152. 2014-12-02 08:53:36 +00:00
Tom Christie
deec61e0d6 Merge pull request #2173 from jpadilla/master
Consolidate Django and test requirements
2014-12-02 08:32:28 +00:00
Tymur Maryokhin
0a91999d6a Merge branch 'master' of github.com:tomchristie/django-rest-framework 2014-12-02 01:50:17 +01:00
José Padilla
bc0c25df30 Consolidate Django and test requirements 2014-12-01 17:31:11 -04:00
José Padilla
080fa4f5f8 Change allow_none to allow_null 2014-12-01 11:26:50 -04:00
Tom Christie
555c450497 Add missing 'validators.py' link. Closes #2166. 2014-12-01 14:46:47 +00:00
phalt
34b5db62e5 Use httpie for tutorials 2014-12-01 13:39:53 +00:00
Tom Christie
1caa14dd14 Minor 3.0 announcment tweaks 2014-12-01 12:22:21 +00:00
Tom Christie
270c7acdd7 Minor validtors tweak 2014-12-01 11:59:04 +00:00
Tom Christie
b9503cd603 Support Django's core ValidationError for backwards compat. Refs #2145. 2014-12-01 10:48:45 +00:00
Tom Christie
72c4ec4e18 Add 3.0 announcement 2014-12-01 08:54:12 +00:00
Tymur Maryokhin
e2ea98e8ab Fixed typos 2014-11-29 20:23:55 +01:00
José Padilla
7f9dc73672 Remove XML support from core 2014-11-29 14:57:51 -04:00
José Padilla
fe745b9616 Remove JSONP support from core 2014-11-29 14:55:33 -04:00
José Padilla
731c8421af Remove YAML support from core 2014-11-29 14:43:05 -04:00
José Padilla
0cc990792c Merge branch 'version-3.1' into oauth_as_package
Conflicts:
	requirements-test.txt
	rest_framework/compat.py
	tests/settings.py
	tox.ini
2014-11-28 12:14:40 -04:00
Tom Christie
caf1de3b88 Minor tweaks to contributing docs 2014-11-28 16:06:44 +00:00
Tom Christie
08c727add3 @api_view defaults to allowing GET 2014-11-28 15:55:02 +00:00
Tom Christie
9ba29a88d6 Finalizing 3.0 release notes 2014-11-28 14:43:33 +00:00
Tom Christie
8e549a76ea Add 2.x notes and links 2014-11-28 14:26:03 +00:00
Tom Christie
66b3daebbd Docs. Sponsor call-out. 2014-11-28 13:14:47 +00:00
Tom Christie
05a86e3d65 Docs. Minor tweaks. 2014-11-28 12:51:44 +00:00
Tom Christie
276a2a52ee Docs on nested creates/updates and suchlike 2014-11-28 11:26:35 +00:00
Tom Christie
d4b8e356b9 Merge branch '3.0-docs' 2014-11-28 09:57:02 +00:00
Tom Christie
34ca8cd2a5 Moar docs. Amazing. 2014-11-28 09:56:44 +00:00
Tom Christie
c61c59f8b7 Notes on removal of Field.validate() and Serializer.transform_<field_name> 2014-11-27 17:01:46 +00:00
Tom Christie
2fe6709769 Fix sponsor images for mkdocs 2014-11-27 11:00:57 +00:00
Tom Christie
0262262fee 3.0 serializer docs 2014-11-27 08:09:58 +00:00
José Padilla
9b88c096e0 Remove Third party packages section
Information about Third party packages is already covered under the Third Party Resources topic
2014-11-26 18:12:12 -04:00
Will Stott
d0e245baba grammar 2014-11-26 15:51:28 +00:00
Will Stott
34bd2b7828 a few typos 2014-11-26 15:48:08 +00:00
Tom Christie
786cab705a Tweak to 3.0 relationship docs 2014-11-26 11:38:48 +00:00
Tom Christie
5a5a73c7fe 3.0 docs and tidy-up for serializer relationships 2014-11-26 11:30:49 +00:00
Tom Christie
678f7b4c65 Update notes on autocomplete 2014-11-26 10:43:45 +00:00
Tom Christie
e1b14cbe4a 3.0 docs for serializer fields 2014-11-26 10:27:29 +00:00
Tom Christie
0f5338ada9 Call out removal of pre_save/post_save more strongly 2014-11-26 09:06:15 +00:00
Tom Christie
c01c631ef2 perform_create, perform_update, perform_destroy hooks 2014-11-26 09:04:48 +00:00
Tom Christie
31536566d7 Updating fields docs 2014-11-25 17:35:27 +00:00
Tom Christie
4ed0ae82e3 Add validators page 2014-11-25 16:29:14 +00:00
Tom Christie
f13c0ebe69 Merge master 2014-11-25 16:27:00 +00:00
Tom Christie
b733f85ff1 Minor docs tweaks 2014-11-25 16:24:35 +00:00
Tom Christie
c7701cd75a Tweak 2014-11-25 16:08:48 +00:00
Tom Christie
929135ea58 Include CNAME file 2014-11-25 16:01:32 +00:00
Tom Christie
d7f8047add Merge branch 'mkdocs' of git://github.com/d0ugal/django-rest-framework into d0ugal-mkdocs 2014-11-25 15:52:36 +00:00
Tom Christie
8c91e7b742 Add missing options 2014-11-25 15:52:13 +00:00
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
Eleni Lixourioti
1aa7783095 Merge branch 'version-3.1' of github.com:tomchristie/django-rest-framework into oauth_as_package
Conflicts:
	.travis.yml
2014-11-15 14:27:41 +00: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
Jharrod LaFon
baa518cd89 Moved OAuth support out of DRF and into a separate package, per #1767 2014-09-05 15:30:01 -07: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
Tom Christie
4d8c63abc9 Deprecate .model in related routers/permissions 2014-08-20 17:15:46 +01:00
Tom Christie
9372cc8c31 Deprecate .model attribute on views 2014-08-20 16:24:52 +01:00
Tom Christie
59b47eac14 Fix cache_throttle typo 2014-08-20 12:32:24 +01:00
Tom Christie
6ffc97c808 Merge pull request #1770 from tomchristie/2.4.0
2.4.0 Release.
2014-08-20 12:06:29 +01:00
Tom Christie
f7b3e1e62b Latest sponsor update 2014-08-20 11:09:04 +01:00
Tom Christie
874d2be83c Release notes 2014-08-20 00:19:03 +01:00
Tom Christie
0c65e028b6 Release notes 2014-08-19 23:25:12 +01:00
Tom Christie
63d02dbea8 Drop six from compat. 1.4.2 is now the lowest supported version. 2014-08-19 17:06:55 +01:00
Tom Christie
00c0dfc66f Documentation on runtests.py 2014-08-19 16:29:05 +01:00
Tom Christie
e385a7b8eb Merge master 2014-08-19 10:11:10 +01:00
Tom Christie
c092b4df78 Merge pull request #1641 from javins/login-title
Refactor login template to extend base.
2014-08-18 20:28:34 +01:00
Tom Christie
2aad8e4b35 Merge pull request #1654 from carltongibson/1559-take-2
Allow use of native migrations in 1.7 — Take 2
2014-08-18 18:54:43 +01:00
Carlton Gibson
556948661a Improve wording. 2014-08-18 13:54:46 +02:00
Carlton Gibson
db4426fc35 Alter other reference to migrations. 2014-08-18 13:52:57 +02:00
Carlton Gibson
ae2ab496c2 Updated docs for South v1.0 2014-08-18 13:48:46 +02:00
Tom Christie
8244c7cc33 Merge pull request #1711 from kdazzle/ModelViewSet-queryset-static-property
Issue #1707: Add documentation to api-docs.viewsets
2014-08-18 12:25:03 +01:00
Tom Christie
61a1eaa485 tabs -> spaces 2014-08-18 11:55:22 +01:00
Tom Christie
92d51c813f Merge pull request #1688 from ekonstantinidis/quick-start-order
Updated quick start project set up order
2014-08-18 11:54:14 +01:00
Tom Christie
dce30207da Remove kickstarter links from homepage and README 2014-08-18 11:09:53 +01:00
Tom Christie
6edbabe0e1 Link to Django docs on widgets. Closes #1760. 2014-08-18 10:58:00 +01:00
Tom Christie
b9cb9929b9 Merge pull request #1761 from sshquack/minor-doc-updates
Trivial doc updates
2014-08-18 10:53:11 +01:00
Tom Christie
38a0e3e627 Sponsor update 2014-08-16 14:02:44 +01:00
sshquack
867e441ec0 Strip trailing spaces in tutorial 2014-08-15 20:45:28 -06:00
sshquack
14867705e9 Specify file names using standard format
+ Explicitly specify module names in the standard format similar to all
the other tutorials
+ Remove the extra quote around module name
2014-08-15 20:41:21 -06:00
Tom Christie
172b9c74f9 Latest sponsor update 2014-08-15 17:48:43 +01:00
Tom Christie
967798e832 Added compile to the sponsors 2014-08-15 17:39:51 +01:00
Tom Christie
4c60639595 Added Holvi 2014-08-15 16:19:13 +01:00
Tom Christie
e624871a68 Latest backer update 2014-08-15 15:46:26 +01:00
Tom Christie
a5561954d7 Latest sponsor updates 2014-08-15 15:36:49 +01:00
catherinedodge
bfd0b261db Fixed small typo 2014-08-14 13:39:21 -04:00
Tom Christie
63d5634c66 Minor sponsor correction 2014-08-14 16:59:40 +01:00
Tom Christie
bdb884aceb Latest sponsor update 2014-08-14 16:57:21 +01:00
Tom Christie
c52075f392 Latest sponsor update 2014-08-13 14:02:09 +01:00
Tom Christie
5d674927b8 Minor docs style change 2014-08-12 14:59:17 +01:00
Tom Christie
c716f35825 Added Cantemo 2014-08-12 14:57:27 +01:00
Tom Christie
7551db23ca Added Rob Spectre 2014-08-12 13:47:34 +01:00
Tom Christie
f46b55b75f Added OpenEye as a silver sponsor 2014-08-12 13:44:00 +01:00
Tom Christie
c6326d0a67 Merge pull request #1745 from nemesisdesign/patch-4
docs: add reference to gis serializer
2014-08-09 07:41:37 +01:00
Federico Capoano
c462a43a87 docs: added reference to gis serializer
added reference to GeoFeatureModelSerializer of django-rest-framework-gis
2014-08-08 14:39:56 +02:00
Federico Capoano
5eb901cd2a docs: added reference to DRF-gis in fields
added django-rest-framework-gis to third party packages section in /docs/api-guide/fields.md
2014-08-08 14:25:02 +02:00
Kevin London
bc03d2b553 Updated links to Bootstrap components
The previous links landed on the the main page and no longer directly linked to specific areas.
2014-08-07 16:32:40 -07:00
Rob Terhaar
3217842346 minor doc fix, @api_view() needs an iterable 2014-08-06 18:55:08 -04:00
nimiq
62d0d4e5d2 Fix style for some text 2014-08-06 12:45:58 +02:00
Tom Christie
83597a4b0f Latest sponsor update 2014-08-05 15:31:39 +01:00
Tom Christie
322476c386 Latest sponsor update 2014-08-04 09:20:27 +01:00
Tom Christie
7bc9954fdb Update sponsorships 2014-08-02 15:28:34 +01:00
Tom Christie
d0fdcdfdad Added pathwright 2014-08-02 15:18:03 +01:00
Tom Christie
3ac075a227 Update Nephila sponsorship 2014-08-02 15:08:14 +01:00
Tom Christie
f58dde59c4 Sponsor updated 2014-08-02 15:05:03 +01:00
Tom Christie
9af3dc0ba5 Added ProReNata AB 2014-08-01 13:54:26 +01:00
Tom Christie
5377bda942 Fix LaterPay link 2014-08-01 13:42:51 +01:00
Tom Christie
27af7a3f4f Latest sponsor updates 2014-08-01 11:36:33 +01:00
Tom Christie
f87aadb3ce Latest sponsor updates 2014-08-01 11:35:48 +01:00
Tom Christie
18f2ca4b02 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-07-31 22:33:59 +01:00
Tom Christie
6677374e9b Kickstarter sponsors 2014-07-31 22:33:45 +01:00
Kevin London
c0f002b09d Updated Permissions doc link to Django docs
The previous link went to version 1 docs so it was a dead link.
2014-07-31 12:41:15 -07:00
Tom Christie
8044416523 Add platinum sponsors 2014-07-31 20:19:28 +01:00
Tom Christie
57d6e04ff5 Add django-rest-framework-mongoengine link. Closes #1722 Closes #1562 Closes #1545 2014-07-30 12:50:36 +01:00
Kyle
fc8eb76c22 Issue #1707 - Add info about queryset property caching to get_queryset() docs.
Add documentation to the get_queryset() method of generic-views.md regarding
the caching of the queryset property.
2014-07-28 10:19:42 -07:00
Kyle
e40ffd60d4 Issue #1707 - Add documentation about the caching of GenericAPIView.queryset
to the `queryset` property, `get_queryset()`, and do generic-views.md; remove
changes to the viewsets.md documentation from my last commit.
2014-07-28 10:11:40 -07:00
Kyle Valade
48b02f016a Issue #1707: Add documentation to api-docs.viewsets notifying users
that they should use the get_queryset() method when overriding a
ModelViewSet method, such as list(). Otherwise, since queryset is
a static property, the value will be cached for every instance of
that ViewSet.
2014-07-27 14:01:43 -07:00
Xavier Ordoquy
4876bec9f5 Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	rest_framework/fields.py
2014-07-26 00:06:56 +02:00
Tom Christie
299a8347e8 Merge pull request #1692 from davbo/patch-1
Update fields.md
2014-07-22 15:59:04 +02:00
Tom Christie
81d15aa9be Add link to drf-extra-fields. Closes #1698 2014-07-20 15:45:45 +01:00
Tom Christie
4324f50437 Phrasing tweak 2014-07-18 11:54:51 +01:00
Tom Christie
ab34ddcf2f Typo 2014-07-18 11:53:23 +01:00
Tom Christie
550243fd26 Beef up the kickstarter announcement 2014-07-18 11:51:48 +01:00
Tom Christie
ead0e60099 Docs for kickstarter announcement 2014-07-17 17:17:41 +01:00
Tom Christie
6bf0f81b0b Kickstarter note on front page 2014-07-17 13:41:19 +01:00
Dave King
680fabe9dd Update fields.md
obj.__class__ will return the actual Class object, we want to serialise a string (accessed with obj.__class__.__name__)
2014-07-17 11:46:59 +01:00
Tom Christie
dd2e950cde Fusion ads 2014-07-15 15:02:09 +01:00
Emmanouil
18eab53e89 Updated quick start project set up order 2014-07-09 15:53:31 +01:00
Tom Christie
b519018125 Docs on object level permissions and filters. Closes #1683 2014-07-07 09:51:23 +01:00
Tom Christie
91eabd54bb Docs tweak 2014-07-01 14:34:23 +01:00
Chibisov Gennady
c1426d1078 Fixes #1651. Add link to drf-extensions nested routers to docs 2014-06-26 23:29:00 +04:00
Carlton Gibson
d98245ac22 Merge branch '2.4.0' of github.com:tomchristie/django-rest-framework into #1559
Conflicts:
	docs/topics/release-notes.md
2014-06-24 10:30:08 +02:00
Carlton Gibson
3f727ce738 Added (first pass) notes to docs & release notes. Backed out SOUTH_MIGRATION_MODULES setting from rest_framework.settings 2014-06-24 09:02:44 +02:00
Xavier Ordoquy
2489e38a06 Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/viewsets.md
	rest_framework/serializers.py
	rest_framework/throttling.py
	tests/test_generics.py
	tests/test_serializers.py
	tox.ini
2014-06-23 14:02:45 +02:00
Walt Javins
b4c7717cb8 Refactor login template to extend base.
While experimenting with extending DRF, I found that the login page
1) had no title, and 2) duplicated <head> info from base.html.

This change adds a new {% block body %} to the base.html template
which allows override of the entire html <body>. login_base.html
has its duplicated head info stripped, and now extends base.html
to share common html <head> templating.

As part of this change, pretify.css is unnecessarily added to
login_base.html.  If this is deemed a problem, it will be easy to
block that css out, and have login_base.html override the block.

Ideally, I would have liked to create a new api_base.html that extends
base.html, move the api specific logic into that template, and leave
base.html content agnostic, to truely be a unifying base for all DRF
pages.  But this change would break current apps that override
api.html and expect base.html to be the immediate super template. :/

This change is benificial because it:
 - removes duplication of header declarations (mostly css includes)
 - adds a html title to the login page
 - standardizes html header info across all DRF pages

Docs are updated to reflect the new structure.
2014-06-13 22:26:00 -07:00
Tom Christie
82659873c9 Fix accidental docs change 2014-06-12 11:48:58 +01:00
Tom Christie
1386767013 Version 2.3.14 2014-06-12 11:47:26 +01:00
Greg Barker
be84f71bc9 Fix #1614 - Corrected reference to serializers.CharField 2014-06-10 15:20:45 -07:00
Rodolfo Carvalho
31f63e1e55 Fix typo in docs 2014-06-02 11:06:03 +02:00
Tom Christie
a7ff51118f Note on configuring TokenAuthentication 2014-05-29 14:33:16 +01:00
khamaileon
eab5933070 Add the allow_add_remove parameter to the get_serializer method 2014-05-26 18:43:50 +02:00
Tom Christie
218b94e606 Merge pull request #1536 from Ian-Foote/choicefield_blank_display_value
Allow customising ChoiceField blank display value
2014-05-20 16:03:51 +01:00
Ian Foote
1e7b5fd2c0 Document ChoiceField blank_display_value parameter 2014-05-20 14:55:00 +01:00
Giorgos Logiotatidis
768f537dcb Typo fix. 2014-05-15 15:42:22 +03:00
Sylvain Bellemare
e033a0b9a0 Replaced singular "is" by plural "are" 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
beb7253a96 Removed unnecessary "that" 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
9dc5e15e5a Added missing "the" word 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
9e3ba939e1 Removed superfluous "./"s 2014-05-05 20:28:00 +02:00
Sylvain Bellemare
05fc974dc9 Added missing "the" word 2014-05-05 14:44:54 +02:00
Sylvain Bellemare
cdc7d19034 Added missing "to" word 2014-05-05 14:41:10 +02:00
Xavier Ordoquy
15c2c58b43 Updated the release-notes. 2014-05-01 08:43:49 +02:00
Xavier Ordoquy
7b4463f739 Merge remote-tracking branch 'reference/2.4.0' into feature/pytest
Conflicts:
	rest_framework/runtests/urls.py
	tests/test_response.py
	tox.ini
2014-05-01 08:01:38 +02:00
Xavier Ordoquy
2aca69a946 Merge remote-tracking branch 'reference/master' into feature/pytest
Conflicts:
	tests/test_serializer.py
2014-04-30 22:24:01 +02:00
Xavier Ordoquy
56b4390316 Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	.travis.yml
	rest_framework/serializers.py
	rest_framework/tests/test_authentication.py
2014-04-30 22:21:26 +02:00
Xavier Ordoquy
d8fb81ceb1 Merge pull request #1391 from kaygorodov/master
Turning off pagination
2014-04-30 20:14:16 +02:00
Laurent Bristiel
d8cb85ef8f typo 2014-04-28 22:00:36 +02:00
dpetzel
5e8f05a8de very minor typo in code example 2014-04-28 13:51:50 -04:00
Xavier Ordoquy
f4a82dd5da Updated the release notes. 2014-04-24 14:33:36 +02:00
Xavier Ordoquy
1797a74e82 Merge remote-tracking branch 'pelme/pytest' into feature/pytest
Conflicts:
	.travis.yml
	rest_framework/runtests/runtests.py
	tests/test_filters.py
	tests/test_pagination.py
	tox.ini
2014-04-17 09:53:44 +02:00
Xavier Ordoquy
d08536ad9d Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/fields.md
	docs/api-guide/routers.md
	docs/topics/release-notes.md
	rest_framework/authentication.py
	rest_framework/serializers.py
	rest_framework/templatetags/rest_framework.py
	rest_framework/tests/test_authentication.py
	rest_framework/tests/test_filters.py
	rest_framework/tests/test_hyperlinkedserializers.py
	rest_framework/tests/test_serializer.py
	rest_framework/tests/test_testing.py
	rest_framework/utils/encoders.py
	tox.ini
2014-04-13 00:05:57 +02:00
Miro Hrončok
f68596a732 Document new UnicodeYAMLRenderer 2014-04-10 01:58:06 +02:00
Craig
3234a5dd6b Fix python syntax in filtering docs 2014-04-08 22:56:07 -04:00
Dmitry Mukhin
e45e52a255 replace page with page_size to avoide confusion 2014-04-07 20:39:45 +04:00
Tom Christie
abe14c06f7 Minor docs tweak 2014-03-17 08:36:13 +00:00
Tom Christie
dddbff5931 Tweak DRF compound fields docs 2014-03-17 08:33:18 +00:00
Steven Cummings
c779dce3e4 Serializer fields section for 3rd-party packages
* Add new section to serializer fields page where we can list and link 3rd-party packages that provide more field types
* Add an entry for drf-compound-fields
2014-03-16 18:55:21 -05:00
Peter Inglesby
2353878951 Add SEARCH_PARAM and ORDERING_PARAM to settings
Fixes #1434
2014-03-06 21:39:44 +00:00
Tom Christie
c1148241ee Version 2.3.13 2014-03-06 09:01:05 +00:00
Andreas Pelme
971578ca34 Support for running the test suite with py.test
* Get rid of runtests.py
 * Moved test code  from rest_framework/tests and rest_framework/runtests to tests
 * Invoke py.test from setup.py
 * Invoke py.test from Travis
 * Invoke py.test from tox
 * Changed setUpClass to be just plain setUp in test_permissions.py
 * Updated contribution guideline to show how to invoke py.test
2014-03-02 12:40:30 +01:00
Kumar McMillan
c2cd610b15 Adds HawkREST to 3rd party auth docs 2014-02-28 16:52:47 -06:00
Kumar McMillan
a4470c4276 Fix trailing whitespace
Sorry, my editor does this automatically
2014-02-28 16:51:32 -06:00
Kumar McMillan
e2857bdcff Fix link to tox 2014-02-28 16:35:03 -06:00
Kumar McMillan
f5f4c1a837 strip trailing whitespace
my editor does this by default
2014-02-28 16:34:42 -06:00
DanSears
abb240648c clarified which urls.py to edit 2014-02-28 08:40:45 -08:00
Charlie Denton
c3967c08ab Minor docs example fix
Dates are smaller when they happen before.
2014-02-21 14:23:33 +00:00
Tom Christie
9841069373 Link to DRF-extensions. Refs #1430 2014-02-20 14:54:17 +00:00
Elvio Toccalino
1a4c6f075b include djangorestframework-httpsignature in the docs 2014-02-20 01:07:39 -03:00
Saurabh Kumar
b3aa512d35 fix(docs): fix code indentation in serializers.md
It fixes the indentation of `restore_object()` in the section "Specifying which fields should be write-only" serializers documentation.
2014-02-18 20:39:39 +05:30
Bo Peng
6f4c2c6f05 Update throttling.md
Added comma to make DEFAULT_THROTTLE_CLASSES a tuple in example, for copy&paste to work nicely.
2014-02-14 13:47:06 -06:00