encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-26 03:23:59 +03:00
Code Issues Packages Projects Releases Wiki Activity
7,732 Commits 18 Branches 132 Tags 105 MiB
8c03c49400
Commit Graph

26 Commits

Author SHA1 Message Date
Carlton Gibson
a540acdc95
Allowed customising API documentation code samples (#5752) 
* Allowed additional languages in API documentation

* Documented renderer_classes parameter and customising languages.
 2018-01-25 09:39:03 +01:00
Jon Dufresne
d3f3c3d9c1 Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
Cristi Vîjdea
522d453546 Add drf-yasg to documentation and schema 3rd party packages (#5720) 
Also fixed broken `swagger` link.
 2018-01-02 14:51:54 +01:00
Jimmy Merrild Krag
ea0b3b32ad Fix typo (#5687) 
Fixed `include_docs_url` to be `include_docs_urls`
 2017-12-19 15:03:47 +01:00
Carlton Gibson
6560f44912
Update OPTIONS example from “Documenting Your API” (#5680) 
Closes #3489

* Updates example to post-3.0 API, using metadata class
* Adds link to metadata docs.
 2017-12-19 12:05:46 +01:00
Carlton Gibson
2befa6c316 Document documentation.py (#5478) 
Closes #5198. Closes #5142. Closes #4980
 2017-10-04 12:12:06 +02:00
Lim H
62ecbf2817 Add drf-openapi (#5470) 
* Add DRF OpenAPI as a 3rd party tool for DRF doc

* Add image

* Add third party packages section to schema doc

* Add DRF OpenAPI reference
 2017-10-02 11:16:33 +02:00
Vašek Dohnal
1f2e2dea96 Fixed typo in docs/Documenting your API (#5316) 2017-08-08 10:01:19 -04:00
Tom Christie
86931b01b6 Note dependancies in docs 2017-03-09 14:59:00 +00:00
Tom Christie
0b708f04e1 Client library & API documentation docs (#4939) 2017-03-06 12:42:51 +00:00
Tom Christie
68d2020112 Live API documentation (#4755) 2017-03-03 15:24:37 +00:00
Binoj David
d58c89adc1 Fix Schemas Example URL 2017-02-28 22:45:17 +05:30
nmgeek
ab0c57718a Direct readers to info on how to add viewset docs (#4844) 
I believe the original statement was wrong.  You can, in fact, document the various API endpoints of a ViewSet.
 2017-01-24 09:57:14 +00:00
Makedonsky
69366a11d7 modify documenting-your-api docs topic 2017-01-03 13:17:07 +02:00
Emmanouil Konstantinidis
ee2861887e Mention DRF Docs - Live API Endpoints 2016-01-23 23:08:19 +00:00
Emmanouil Konstantinidis
1925ec7d33 Both are highly recommended 2015-12-21 13:59:05 +00:00
Emmanouil Konstantinidis
4204557bc5 Remove title and hr 2015-12-21 13:55:11 +00:00
Emmanouil Konstantinidis
958290724c Rest is "REST" 2015-12-21 13:47:04 +00:00
Emmanouil Konstantinidis
a83cb1d2f3 Minor changes 2015-12-21 13:45:11 +00:00
Emmanouil Konstantinidis
1aedaafba4 Add DRF docs to the list 2015-12-21 13:40:23 +00:00
José Padilla
200e0b17da Clean up extra white space 2014-11-25 12:44:11 +00:00
catherinedodge
bfd0b261db Fixed small typo 2014-08-14 13:39:21 -04:00
Veronica Lynn
4d8d2340be Fixed typos in a bunch of docs 2013-08-07 14:00:06 -04:00
Tom Christie
0950d3e0ef Tweak docs 2013-07-04 08:02:08 +01:00
Tom Christie
7c0019854b Horizontal rule for nicer formatting 2013-07-03 13:19:07 +01:00
Tom Christie
03e0ce35fe Added 'Documenting your API' section. Closes #616 2013-07-02 22:15:46 +01:00