Commit Graph

337 Commits

Author SHA1 Message Date
Tom Christie
fe5db41949 Fix typo 2012-10-13 15:12:44 +01:00
Tom Christie
e4f43be47f Merge pull request #293 from tomchristie/request-documentation
Improve documentation for Requests
2012-10-13 07:10:12 -07:00
Tom Christie
7608cf1193 Improve documentation for Requests 2012-10-13 15:07:43 +01:00
Jamie Matthews
7367bd53a9 Fix tiny typo 2012-10-12 10:02:21 +02:00
Tom Christie
648d2be29b Make sure JSON output in Browseable API is nicely indented 2012-10-10 12:15:18 +01:00
Tom Christie
ccd2b0117d Permissions and throttles no longer have a view attribute on self. Explicitly passed to .has_permissions(request, view, obj=None) / .allow_request(request, view) 2012-10-10 10:02:37 +01:00
Tom Christie
44281c3996 Remove 'tut 6 - resources' from the docs, since it doesn't exist yet 2012-10-10 09:36:18 +01:00
Tom Christie
9bbc1cc403 Add flag in get_related_field 2012-10-09 17:49:04 +01:00
Tom Christie
b0c370dd2b Fixed couple of incorrect imports in the docs 2012-10-09 17:36:03 +01:00
Tom Christie
52a2ff8f77 Docs tweaks 2012-10-09 16:44:49 +01:00
Tom Christie
97a7f27c82 Rename HTMLTemplateRenderer -> HTMLRenderer, DocuemntingHTMLRenderer -> BrowseableAPIRenderer 2012-10-09 15:58:48 +01:00
Tom Christie
ce21fa1dc6 Tweak static files with docs 2012-10-09 14:12:38 +01:00
Tom Christie
94401b43d2 Flesh out quickstart guide and make some style tweaks 2012-10-09 13:50:26 +01:00
Tom Christie
7c4d50f621 Fix browseable API form display error for authenticated permissions 2012-10-09 12:48:49 +01:00
Tom Christie
e9475d036f Tweak settings in quickstart guide 2012-10-09 12:03:29 +01:00
Tom Christie
115e61be09 Added quickstart guide 2012-10-09 12:01:17 +01:00
Tom Christie
65f592866c Fix issue where required fields were not being properly validated. Also make model fields with a default value be not required 2012-10-08 17:53:18 +01:00
Tom Christie
b581ffe323 Docs tweaks 2012-10-08 15:46:52 +01:00
Tom Christie
9ade21c793 Fix broken docs reference 2012-10-08 14:26:42 +01:00
Tom Christie
f79ed6175d Add RetrieveDestroyAPIView and remove Metadata mixin 2012-10-08 14:13:15 +01:00
Tom Christie
4fd8ab17a3 Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-10-08 12:18:43 +01:00
Tom Christie
f4d4d54e03 Adding migration and changelog docs 2012-10-08 12:17:43 +01:00
Tom Christie
321d4d030a Added @mattbo, @maximilianhurl. Thanks! 2012-10-07 21:30:06 +02:00
Tom Christie
6b6c945d4e Fix up media-specific doc styling issues 2012-10-06 20:05:36 +01:00
Tom Christie
fd1b660e06 DabApps, not Dab Apps 2012-10-05 19:33:13 +01:00
Tom Christie
9bc4aead65 Tweak fields docs 2012-10-05 19:26:57 +01:00
Tom Christie
0b08d25297 Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-10-05 19:26:45 +01:00
Tom Christie
268131ce37 Add serializer fields documentation 2012-10-05 17:10:07 +01:00
Tom Christie
4e7fffa993 Merge pull request #284 from maximilianhurl/doc-styles
Added sticky footer and styles to HTML API page
2012-10-05 09:04:17 -07:00
Tom Christie
cc21948a69 Fix django 1.3 bug 2012-10-05 17:02:33 +01:00
Max Hurl
101f06b50b Added dabapps styling to html api 2012-10-05 17:00:24 +01:00
Max Hurl
bdbf988781 Added sticky footer to docs 2012-10-05 16:32:41 +01:00
Tom Christie
272fddc952 Fix bug in format suffix patterns 2012-10-05 15:37:50 +01:00
Tom Christie
9ac6fcf19c Add favicon to docs 2012-10-05 15:26:15 +01:00
Tom Christie
84958d131a Doc style tweaks 2012-10-05 15:22:30 +01:00
Tom Christie
3e862c7737 Tweak view slightly 2012-10-05 14:22:02 +01:00
Tom Christie
6a15556384 Docs tweaks 2012-10-05 14:00:02 +01:00
Tom Christie
1a09983dfc Tweak doc headings 2012-10-05 13:51:09 +01:00
Tom Christie
2455bebd87 Merge pull request #282 from tomchristie/html-template-responses
Html template responses
2012-10-05 05:11:17 -07:00
Tom Christie
61a6d0c109 Fix travis build image in docs 2012-10-05 13:09:10 +01:00
Tom Christie
2575ea92aa Docs for template responses 2012-10-05 13:04:34 +01:00
Max Hurl
5fd6d87a93 Added JS version numbers 2012-10-05 12:43:35 +01:00
Max Hurl
f70a5edc1f Added dabapps styles and general improvements to docs 2012-10-05 12:29:53 +01:00
Tom Christie
26c7d6df6c HTMLTemplateRenderer working 2012-10-05 12:13:44 +01:00
Tom Christie
d07dc77e91 Accepted media type uses most specific of client/renderer media types. 2012-10-05 10:23:47 +01:00
Tom Christie
bcd2caf559 Abstract out the app_label on test models 2012-10-04 09:18:46 +01:00
Tom Christie
d8b05201ed Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-10-03 09:46:12 +01:00
Tom Christie
c30e0795be Rename generic views 2012-10-03 09:26:15 +01:00
Matt Bosworth
934492ebd0 Fixed references to serializer.serialized and serializer.serialized_errors
in part 3 of the tutorial.  Altered part 1 to use blogs/urls.py since it was
specified at the beginning.  Also caught some spelling errors while I was at it.
2012-10-02 22:41:03 -07:00
Tom Christie
b89125ef53 Update view docs slightly 2012-10-02 21:26:15 +01:00
Tom Christie
e1518de68f Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-10-02 19:54:24 +01:00
Tom Christie
31b06f1721 Cleaner travis image link 2012-10-02 19:54:20 +01:00
Tom Christie
ab173fd8f9 Fix bug where pk could be set in post data 2012-10-02 15:37:13 +01:00
Tom Christie
e7685f3eb5 URL overrides in settings fixed up slightly 2012-10-02 15:24:42 +01:00
Tom Christie
8855a462c6 Clean up docs slightly 2012-10-02 11:48:25 +01:00
Tom Christie
b526b82abf Placeholder for FBV docs 2012-10-02 11:04:06 +01:00
Tom Christie
34637bf857 Make example more realistic and less of a toy 2012-10-02 11:03:51 +01:00
Tom Christie
ae8a827004 Make 'results_field' attribute of BasePaginationSerializer public. 2012-10-02 10:40:43 +01:00
Tom Christie
2284e592de Clean up reverse docs slightly 2012-10-02 10:40:04 +01:00
Tom Christie
a8f6ac3f3a Renderer documentation 2012-10-02 10:39:28 +01:00
Tom Christie
dae6d09398 Add example of using paginator in a view 2012-10-01 16:27:22 +01:00
Tom Christie
8d1d990187 Pagination docs 2012-10-01 16:17:01 +01:00
Tom Christie
b16fb57771 Expand pagination support, add docs 2012-10-01 15:49:19 +01:00
Tom Christie
43d3634e89 Docs tweaking 2012-09-30 15:55:24 +01:00
Tom Christie
aeeb68f68a Added @j4mie, and added projects to 'additional thanks' as appropriate. 2012-09-28 10:42:14 +01:00
Tom Christie
ee36e4ab0c Only display forms when user has permissions. #159 2012-09-27 21:51:46 +01:00
Tom Christie
8582b18ac4 Added @cyberj. Thanks! 2012-09-27 14:29:14 +02:00
Tom Christie
89a0b22306 Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-09-27 13:06:34 +01:00
Tom Christie
061cffb67b Added citation to contributing docs 2012-09-27 12:49:08 +01:00
Tom Christie
da1f6df4fa Added @LaundroMat. Thanks! 2012-09-26 23:07:59 +02:00
Tom Christie
0cc7030aab Fix @api_view decorator tests 2012-09-26 21:47:19 +01:00
Tom Christie
6fc5581a8f Add readonly 'id' field 2012-09-25 13:40:16 +01:00
Tom Christie
4fb57d28e6 Add csrf note 2012-09-25 12:27:46 +01:00
Tom Christie
921c5840aa Fix incorrect bit of tutorial 2012-09-25 12:21:35 +01:00
Tom Christie
4b691c4027 Change package name: djangorestframework -> rest_framework 2012-09-20 13:06:27 +01:00
Tom Christie
db13401af0 Added @phobologic. Thanks\! 2012-09-19 17:06:43 +01:00
Tom Christie
575630d7c3 Use named links in tutorial docs 2012-09-19 13:02:10 +01:00
Tom Christie
5611769162 Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-09-17 20:20:27 +01:00
Tom Christie
308677037f Tweak docs, fix .error_data -> .errors 2012-09-17 20:19:45 +01:00
Alec Perkins
43c2a15f9d Prevent the touchstart event propagation on the dropdown menus in the navbar.
This allows the dropdowns to be used on a touch device.
2012-09-17 10:01:44 -04:00
Tom Christie
a96211d3d1 Simplify negotiation. Drop MSIE hacks. Etc. 2012-09-16 21:48:55 +01:00
Tom Christie
a5213d4023 Drop urlobject2 2012-09-14 13:24:13 +01:00
Tom Christie
f204439fa8 Merge branch 'browsable-bootstrap' of https://github.com/droptype/django-rest-framework into droptype-browsable-bootstrap 2012-09-14 12:52:12 +01:00
Tom Christie
eb761be9d0 Flesh out resources/routers part of tutorial 2012-09-14 12:43:14 +01:00
Tom Christie
886f8b4751 Tweak throttles and improve docs 2012-09-14 08:54:58 +01:00
Tom Christie
3005079824 Drop GitHub button from docs on small screens 2012-09-13 18:39:08 +01:00
Tom Christie
d8b5d6603e Tweak copy 2012-09-13 18:35:06 +01:00
Tom Christie
6c109ac60f Improve throttles and docs 2012-09-13 18:32:56 +01:00
Tom Christie
b16c45aa6d Tweak throttling/permissions/auth docs 2012-09-13 09:39:16 +01:00
Tom Christie
003a65f0e0 Tweaks to Token auth 2012-09-12 20:39:22 +01:00
Tom Christie
dac4cb9e8b GitHub link in toolbar 2012-09-12 13:11:26 +01:00
Tom Christie
c85f799ade Updating docs 2012-09-12 10:12:13 +01:00
Alec Perkins
4cbc53a75d Whoops, forgot to explain these. 2012-09-09 17:27:24 -04:00
Alec Perkins
9684b3fe22 Reference-style links. Much cleaner. 2012-09-09 17:07:54 -04:00
Alec Perkins
60e6bba12b Browsable API doc topic 2012-09-09 17:02:19 -04:00
Tom Christie
d4f8b4cf06 Collapsing menu, travis and github badges, horizontal scrolling code on overflow 2012-09-09 16:56:04 +01:00
Tom Christie
baa6e2c18b Hide toc overflow 2012-09-08 22:31:44 +01:00
Tom Christie
b5e07abc15 Move quote below title for consistency 2012-09-08 22:13:11 +01:00
Tom Christie
247696e820 Links to source files in docs 2012-09-08 22:06:13 +01:00
Tom Christie
5d9dfcd8ae Code highlighting in docs 2012-09-08 20:23:32 +01:00
Tom Christie
382b277dfc Link to github accounts in credits 2012-09-08 08:41:31 +01:00
Tom Christie
79144919f6 Added @alecperkins. 2012-09-08 08:38:14 +01:00
Tom Christie
8f119a8c34 Merge pull request #253 from droptype/rf2-docfixes
Fixes for the documentation styles
2012-09-07 15:25:58 -07:00
Tom Christie
80c50bfd2d Merge pull request #252 from markotibold/docs-fixes
Some minor docs fixes
2012-09-07 14:12:32 -07:00
Marko Tibold
8ee763739d Add some missing imports.
Fix some typos.
Fix some indentation errors.
2012-09-07 22:53:02 +02:00
Mjumbe Wawatu Poe
8df71f4d1d Get rid of the BaseToken abstract model 2012-09-07 16:19:15 -04:00
Mjumbe Wawatu Poe
f741cdae44 Move TokenAuthentication class into djangorestframework.authentication 2012-09-07 16:15:33 -04:00
Alec Perkins
f95f96aba7 [docs] Fix typo, add link to Tom's Twitter profile 2012-09-07 14:31:24 -04:00
Mjumbe Wawatu Poe
3b1404bd7d Rename the default token class to "BasicToken" 2012-09-07 14:23:53 -04:00
Mjumbe Wawatu Poe
36cd91bbbe Update docs for tokenauth 2012-09-07 14:12:46 -04:00
Alec Perkins
7f681d72fc [docs] Update jQuery to 1.8.1 2012-09-07 14:12:29 -04:00
Alec Perkins
30dedc95e5 [docs] Spacing tweaks when getting responsive. 2012-09-07 13:52:44 -04:00
Alec Perkins
6d7d70c1c0 [docs] Move styles to own file. Fix table-of-contents positioning when viewed on <767px screens.
The fixed positioning of the ToC needs to be overridden with static, so that the ToC falls back into the flow of content and is sized correctly. Also, this prevents the actual page content from riding up behind the ToC and being obscured.
2012-09-07 13:05:44 -04:00
Alec Perkins
17654a8b54 [docs] Add bootstrap-collapse plugin, fixing collapsing navbar. 2012-09-07 13:01:30 -04:00
Alec Perkins
3306e448ef [docs] Update Bootstrap to 2.1.1 2012-09-07 13:01:01 -04:00
Tom Christie
72bdd0fcec Add basic serializer tests 2012-09-07 15:14:23 +01:00
Tom Christie
a01d615354 Add note re. browseable API and @api_view decorator 2012-09-07 13:55:02 +01:00
Tom Christie
215de9af81 Tidy up 2012-09-07 10:17:47 +01:00
Tom Christie
da5a6243f3 Filling out docs a bit more 2012-09-07 09:37:06 +01:00
Tom Christie
c648f2786f TODO notes in docs 2012-09-06 16:46:56 +01:00
Tom Christie
c707034649 Add more settings to settings.py 2012-09-06 15:57:16 +01:00
Tom Christie
224b538b31 Tidying up docs 2012-09-05 21:14:00 +01:00
Tom Christie
3a106aed79 Flesh out authentication docs 2012-09-05 20:10:06 +01:00
Tom Christie
15482f443a Make index consistent 2012-09-05 18:25:48 +01:00
Tom Christie
ef5279e97c Improve docs 2012-09-05 13:03:55 +01:00
Tom Christie
3a17723bd5 Update api auth include 2012-09-05 10:41:41 +01:00
Tom Christie
40d1821f2d Add missing doc files 2012-09-05 10:01:43 +01:00
Tom Christie
6e21915934 First pass at mixins & generic views 2012-09-03 17:49:22 +01:00
Tom Christie
1a1ccf94c2 Fixes to APIView 2012-09-03 16:42:57 +01:00
Tom Christie
93189ec27d Added format_suffix_patterns, and fix up settings 2012-09-03 16:06:17 +01:00
Tom Christie
149b00a070 Added the api_view decorator 2012-09-03 15:57:43 +01:00
Tom Christie
7abef9ac3b Parsers may return raw data, or a DataAndFiles object 2012-09-03 14:28:40 +01:00
Tom Christie
d180e984e9 Neater virtualenv in tutorial 2012-09-03 13:44:49 +01:00
Tom Christie
a25b4be441 Support generators 2012-09-03 13:30:20 +01:00
Tom Christie
ebbaff0853 Update virtualenv notes 2012-09-03 13:10:39 +01:00
Tom Christie
247a422a64 Add virtualenv to start of tutorial 2012-09-03 12:41:52 +01:00
Tom Christie
c191a46ef0 Update credits 2012-09-03 12:19:16 +01:00
Tom Christie
ddc8c30317 Cleaner documentation around installation of optional packages 2012-09-03 12:11:57 +01:00
Tom Christie
73d337ea5d Fix credits doc 2012-09-01 23:14:48 +01:00
Tom Christie
b9177f740b Docs tweak for first docs deployment 2012-09-01 21:35:30 +01:00
Tom Christie
9941556474 Get docs ready to deploy 2012-09-01 21:23:50 +01:00
Tom Christie
deedf6957d REST framework 2 docs 2012-09-01 20:26:27 +01:00
Tom Christie
578017e01d New docs 2012-08-29 20:57:37 +01:00
Tom Christie
44df8345f3 Merge with master 2012-04-11 15:28:57 +01:00
Tom Christie
1751655927 Update docs/requirements.txt 2012-02-27 10:06:20 +00:00
Tom Christie
1cde31c86d Massive merge 2012-02-25 18:45:17 +00:00
Tom Christie
66eabe8bd1 Remove staticviews. Use standard login/logout 2012-02-21 22:50:41 +00:00
Tom Christie
5fd4c639d7 Merge master into develop 2012-02-21 20:57:36 +00:00
Tom Christie
ca9465f11e reverse gets it's own module 2012-02-21 20:47:55 +00:00
Tom Christie
af9e4f69d7 Merging master into develop 2012-02-21 20:12:14 +00:00