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
Daniel Izquierdo
8f5b093c0d
Include the `utils' module in the docs
2012-02-21 22:51:32 +09:00
Daniel Izquierdo
86d470796e
Add a HOWTO page for the custom `reverse()'
2012-02-21 22:51:32 +09:00
Tom Christie
6c5fb56257
Update docs
2012-02-20 20:31:41 +00:00
Paul Oswald
50198935af
Rename templates to 'base.html', 'api.html', 'api.txt' and 'login.html'
2012-02-20 22:16:51 +09:00
Tom Christie
fbf76c87af
Merge git://github.com/sebpiq/django-rest-framework into develop
2012-02-17 09:19:13 +00:00
Paul Oswald
bf717eff64
Documentation on how to override the template; Closes Issue #165
2012-02-15 10:38:25 +09:00
Paul Oswald
9c8ca51c78
Delete robots.txt, favicon.ico views; Move style to a new static namespace
2012-02-14 11:25:59 +09:00
Sébastien Piquemal
6963fd3623
some docs for Request/Response/mixins
2012-02-07 16:22:14 +02:00
Sébastien Piquemal
5f59d90645
merged with trunk's master
2012-02-02 08:39:15 +02:00
Marko Tibold
39d4a39441
renamed to CHANGELOG.rst and included release notes in index.rst
2012-01-30 18:29:54 +01:00
Sébastien Piquemal
152c385f4d
enhanced request how-to + example
2012-01-25 00:11:54 +02:00
Sébastien Piquemal
714a90d755
documentation for request module
2012-01-24 21:21:10 +02:00
Marko Tibold
ccbb536896
Merge remote-tracking branch 'upstream/master'
2012-01-02 21:17:12 +01:00
Marko Tibold
e0b82ce76d
minor style edits
2012-01-02 21:16:44 +01:00
Tom Christie
17290b0beb
Add 1.4
2012-01-02 18:39:55 +00:00
Tom Christie
0b21af9388
Drop mercurial reference.
2012-01-02 18:31:46 +00:00
Marko Tibold
7a3d97a2fc
:mod: directive is nicer here
2012-01-02 18:42:22 +01:00
Marko Tibold
9871532746
Added an example of how to use authentication and throttling.
2012-01-02 18:12:22 +01:00
Marko Tibold
e419e2066f
Colouring of literal code
...
Get the nice colouring sphinx provides and fix some more typos.
2011-12-30 19:03:05 +01:00
Marko Tibold
e44f182fcf
typos
2011-12-30 18:52:15 +01:00
Marko Tibold
e82ab8ea31
Added a simple example of how to use urllib and urllib2 to interact
...
with an api.
2011-12-30 18:46:18 +01:00
Marko Tibold
28f1b027aa
Merge remote-tracking branch 'origin/master'
2011-12-30 16:17:12 +01:00
Marko Tibold
abf0ee8b97
some more refactoring and some style enhancements. Just committing
...
to stay in sync.
2011-12-30 16:13:24 +01:00
Marko Tibold
a1d31c8a3a
drop linkchecking
2011-12-30 16:01:15 +01:00
Marko Tibold
1b28339e5b
Merge remote-tracking branch 'upstream/master'
2011-12-30 01:37:32 +01:00
Marko Tibold
91cee26ad8
Some initial refactoring of the docs.
2011-12-30 01:36:43 +01:00
Tom Christie
d87113ff60
For now just point the examples at rest.ep.io
...
Would be nice to keep the custom subdomain, but too much of a PITA
right now.
2011-12-29 13:54:39 +00:00
Marko Tibold
1096e06c2d
set linkcheck_timeout to very large, to prevent timeouts on the CI.
2011-12-21 02:23:26 +01:00
Marko Tibold
c509c2bff2
Merge remote-tracking branch 'upstream/master'
2011-12-15 14:56:47 +01:00
Marko Tibold
beccc54d11
Update docs/howto/setup.rst
2011-12-15 14:56:01 +01:00
Marko Tibold
59904576a2
reduced output to errors and warnings only
2011-12-15 12:25:56 +01:00
Marko Tibold
670dbe6d75
Don't output html to a tempdir, but keep them.
2011-12-15 01:16:09 +01:00
Marko Tibold
0f16db7614
see previous commit message.
2011-12-15 00:31:57 +01:00
Marko Tibold
e2b9359a2d
Adding a docs env to the tox project.
...
This will run the linkcheck and build the html docs, turning any warnings into
errors.
Also changed the theme to sphinx-doc and added version to be displayed in the
docs.
2011-12-15 00:27:29 +01:00
Marko Tibold
ac18bea009
deleted reference to bitbucket from the docs
2011-12-12 20:53:10 +01:00
Tom Christie
59afd87cd4
We do not have a blog. We do not host on BitBucket.
2011-12-09 11:28:50 +00:00
Tom Christie
1cb84cd4e8
Merge throttling and fix up a coupla things
2011-06-15 14:41:09 +01:00
Tom Christie
7dcb851c7f
Allow related models to be fully serialized
2011-06-15 14:09:01 +01:00
Tom Christie
412b5fc2d5
Support for nesting resources etc...
...
--HG--
rename : djangorestframework/tests/resources.py => djangorestframework/tests/serializer.py
2011-06-14 18:22:13 +01:00
markotibold
1720c44904
I added a dns record to my domain: jenkins.tibold.nl
2011-06-13 14:44:12 +02:00
Tom Christie
0da291fad3
Fix up the example
2011-06-09 02:07:46 +01:00
Tom Christie
3531b0b355
More updating docs for 0.2
...
--HG--
rename : docs/examples/modelresources.rst => docs/examples/modelviews.rst
rename : docs/examples/resources.rst => docs/examples/views.rst
2011-06-02 16:03:11 +01:00
Tom Christie
bf9ea978bc
Updating docs for 0.2
2011-06-02 15:22:14 +01:00
Tom Christie
5591a71a13
updating docs for 0.2
2011-06-02 13:34:23 +01:00
markotibold
82c4ca9612
The core is now documented from the docstrings in the source.
2011-05-19 19:36:30 +02:00
Tom Christie
bfbb8ceccf
Merge Marko's doc improvements.
2011-05-17 09:15:35 +01:00
markotibold
66b9bda9bf
All top level modules are included. Ready for diving into the modules and documenting/ enhancing already existing docs.
2011-05-17 00:18:45 +02:00
markotibold
304786657a
Getting rid of all errors and warnings that show up when building the docs, to make a clean start with the library documentation .
...
--HG--
rename : docs/library/authenticators.rst => docs/library/authentication.rst
rename : docs/library/emitters.rst => docs/library/renderers.rst
2011-05-16 23:54:35 +02:00
markotibold
032cb79592
fix tiny spelling errors
2011-04-27 22:28:08 +02:00
Tom Christie
683a862ddf
Docs impovement
2011-04-27 18:25:11 +01:00
tom christie tom@tomchristie.com
bba89cbcf1
Doc tweaking again. Must get back to some proper stuff soon...
2011-03-05 21:55:45 +00:00
tom christie tom@tomchristie.com
69c567cd87
Doc tweaking again. Must get back to some proper stuff soon...
2011-03-05 21:49:06 +00:00
tom christie tom@tomchristie.com
60206e5288
./examples/modelresourceexample/models.py
2011-03-03 09:02:41 +00:00
tom christie tom@tomchristie.com
0798cc141f
More nonsense in the docs
2011-02-22 22:54:09 +00:00
tom christie tom@tomchristie.com
8685357e97
Add the .zip download to the docs
2011-02-22 00:03:15 +00:00
tom christie tom@tomchristie.com
aae848cace
Nitpicking
2011-02-21 22:23:09 +00:00
tom christie tom@tomchristie.com
92dd13912a
Add pip/easy_install to the docs
2011-02-21 22:21:49 +00:00
tom christie tom@tomchristie.com
bddcacefe7
Minor notes on installation
2011-02-19 19:19:32 +00:00
tom christie tom@tomchristie.com
ec5eaa56c1
Minor notes on installation
2011-02-19 19:15:16 +00:00
tom christie tom@tomchristie.com
114738ca72
Add setup.py
2011-02-19 18:41:23 +00:00
tom christie tom@tomchristie.com
38c6a37af7
Minor doc tweaks
2011-02-19 15:50:40 +00:00
tom christie tom@tomchristie.com
66f595f41a
Link to django docs on serving admin media
2011-02-19 13:36:38 +00:00
tom christie tom@tomchristie.com
5ddc941656
Mention deny robots, favicon and login/logout views
2011-02-19 13:28:21 +00:00
tom christie tom@tomchristie.com
eac562b2ec
Note the sandbox API a couple more times, just in case they didn't get the message yet.
2011-02-19 13:22:12 +00:00
tom christie tom@tomchristie.com
e4fff6ea6e
Clean up the docs
2011-02-19 13:12:35 +00:00
tom christie tom@tomchristie.com
fcd7f414c4
Huge stack of refactoring getting stuff into Mixin classes, and loads of tests. Kickass.
2011-02-04 21:52:21 +00:00
tom christie tom@tomchristie.com
eebcdc4dc0
typo
2011-02-04 21:41:53 +00:00
tom christie tom@tomchristie.com
b4e8ecbec7
More improving of docs
2011-02-02 08:44:47 +00:00
tom christie tom@tomchristie.com
fa1ec50765
More improving of docs
2011-02-02 08:43:27 +00:00
tom christie tom@tomchristie.com
02c29db857
Updated docs with resourceexample
2011-02-01 23:08:18 +00:00
tom christie tom@tomchristie.com
3a8facdb2a
Remove Google Analytics from template
2011-02-01 22:38:39 +00:00
tom christie tom@tomchristie.com
6ce5b643fb
Added resourceexample, moved simpleexample to modelresourceexample
2011-02-01 22:37:51 +00:00
tom christie tom@tomchristie.com
0c6f682cd0
Fix errant uppercasing in docs
2011-02-01 20:00:16 +00:00
tom christie tom@tomchristie.com
38f6d7c119
Remove remaining bit of google analytics in template
2011-02-01 19:58:11 +00:00
tom christie tom@tomchristie.com
478dc2d0ce
Fix up doc title & desc, fix repo link
2011-02-01 19:55:57 +00:00
tom christie tom@tomchristie.com
98b5b2abd8
Minor docs changes
2011-01-31 08:48:26 +00:00
tom christie tom@tomchristie.com
9024c2e94e
Going live
2011-01-31 08:41:21 +00:00
tom christie tom@tomchristie.com
42f2f9b40d
Rename to django-rest-framework, get simpleexample working
2011-01-30 18:30:39 +00:00
tom christie tom@tomchristie.com
8a470f031e
Minor changes to examples and docs
2011-01-30 16:51:06 +00:00
tom christie tom@tomchristie.com
f6e534321a
Move library docs into seperate folder
2011-01-30 11:02:14 +00:00
tom christie tom@tomchristie.com
250ab0f609
Lots of docs, trying to tidy up examples...
2011-01-30 11:00:20 +00:00
Tom Christie
40f47a9fb3
Minor bit of tidy up (all the stuff I noticed when demoing to francis)
2011-01-28 17:42:57 +00:00
tom christie tom@tomchristie.com
110bf85aeb
./flywheel/emitters.py
2011-01-27 22:00:34 +00:00
tom christie tom@tomchristie.com
6807cf014c
Added pygments_api example
2011-01-26 08:58:09 +00:00
tom christie tom@tomchristie.com
eff54c00d5
Added authenicators. Awesome.
2011-01-24 18:59:23 +00:00
tom christie tom@tomchristie.com
4100242fa2
Sphinx docs, examples, lots of refactoring
2011-01-23 23:08:16 +00:00
Tom Christie
9979903272
Mostly improving documentation
2011-01-17 17:34:58 +00:00