10000 Documentation update (#4717) · hakjoon/django-rest-framework@2257852 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2257852

Browse files
xordoquytomchristie
xordoquy
authored and
tomchristie
committed
Documentation update (encode#4717)
1 parent 4f6c326 commit 2257852

21 files changed

+36
-36
lines changed

‎docs/api-guide/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a
363363
[oauth]: http://oauth.net/2/
364364
[permission]: permissions.md
365365
[throttling]: throttling.md
366-
[csrf-ajax]: https://docs.djangoproject.com/en/dev/ref/csrf/#ajax
366+
[csrf-ajax]: https://docs.djangoproject.com/en/stable/ref/csrf/#ajax
367367
[mod_wsgi_official]: http://code.google.com/p/modwsgi/wiki/ConfigurationDirectives#WSGIPassAuthorization
368368
[django-oauth-toolkit-getting-started]: https://django-oauth-toolkit.readthedocs.io/en/latest/rest-framework/getting_started.html
369369
[django-rest-framework-oauth]: http://jpadilla.github.io/django-rest-framework-oauth/

‎docs/api-guide/fields.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -665,12 +665,12 @@ The [django-rest-framework-gis][django-rest-framework-gis] package provides geog
665665

666666
The [django-rest-framework-hstore][django-rest-framework-hstore] package provides an `HStoreField` to support [django-hstore][django-hstore] `DictionaryField` model field.
667667

668-
[cite]: https://docs.djangoproject.com/en/dev/ref/forms/api/#django.forms.Form.cleaned_data
668+
[cite]: https://docs.djangoproject.com/en/stable/ref/forms/api/#django.forms.Form.cleaned_data
669669
[html-and-forms]: ../topics/html-and-forms.md
670-
[FILE_UPLOAD_HANDLERS]: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-FILE_UPLOAD_HANDLERS
670+
[FILE_UPLOAD_HANDLERS]: https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-FILE_UPLOAD_HANDLERS
671671
[ecma262]: http://ecma-international.org/ecma-262/5.1/#sec-15.9.1.15
672672
[strftime]: https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior
673-
[django-widgets]: https://docs.djangoproject.com/en/dev/ref/forms/widgets/
673+
[django-widgets]: https://docs.djangoproject.com/en/stable/ref/forms/widgets/
674674
[iso8601]: http://www.w3.org/TR/NOTE-datetime
675675
[drf-compound-fields]: https://drf-compound-fields.readthedocs.io
676676
[drf-extra-fields]: https://github.com/Hipo/drf-extra-fields

‎docs/api-guide/filtering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -455,14 +455,14 @@ The [djangorestframework-word-filter][django-rest-framework-word-search-filter]
455455

456456
[drf-url-filter][drf-url-filter] is a simple Django app to apply filters on drf `ModelViewSet`'s `Queryset` in a clean, simple and configurable way. It also supports validations on incoming query params and their values. A beautiful python package `Voluptuous` is being used for validations on the incoming query parameters. The best part about voluptuous is you can define your own validations as per your query params requirements.
457457

458-
[cite]: https://docs.djangoproject.com/en/dev/topics/db/queries/#retrieving-specific-objects-with-filters
458+
[cite]: https://docs.djangoproject.com/en/stable/topics/db/queries/#retrieving-specific-objects-with-filters
459459
[django-filter]: https://github.com/alex/django-filter
460460
[django-filter-docs]: https://django-filter.readthedocs.io/en/latest/index.html
461461
[guardian]: https://django-guardian.readthedocs.io/
462462
[view-permissions]: https://django-guardian.readthedocs.io/en/latest/userguide/assign.html
463463
[view-permissions-blogpost]: http://blog.nyaruka.com/adding-a-view-permission-to-django-models
464464
[nullbooleanselect]: https://github.com/django/django/blob/master/django/forms/widgets.py
465-
[search-django-admin]: https://docs.djangoproject.com/en/dev/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields
465+
[search-django-admin]: https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields
466466
[django-rest-framework-filters]: https://github.com/philipn/django-rest-framework-filters
467467
[django-rest-framework-word-search-filter]: https://github.com/trollknurr/django-rest-framework-word-search-filter
468468
[django-url-filter]: https://github.com/miki725/django-url-filter

‎docs/api-guide/generic-views.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ The [django-rest-framework-bulk package][django-rest-framework-bulk] implements
382382
[Django Rest Multiple Models][django-rest-multiple-models] provides a generic view (and mixin) for sending multiple serialized models and/or querysets via a single API request.
383383

384384

385-
[cite]: https://docs.djangoproject.com/en/dev/ref/class-based-views/#base-vs-generic-views
385+
[cite]: https://docs.djangoproject.com/en/stable/ref/class-based-views/#base-vs-generic-views
386386
[GenericAPIView]: #genericapiview
387387
[ListModelMixin]: #listmodelmixin
388388
[CreateModelMixin]: #createmodelmixin

‎docs/api-guide/pagination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ The [`DRF-extensions` package][drf-extensions] includes a [`PaginateByMaxMixin`
325325

326326
The [`drf-proxy-pagination` package][drf-proxy-pagination] includes a `ProxyPagination` class which allows to choose pagination class with a query parameter.
327327

328-
[cite]: https://docs.djangoproject.com/en/dev/topics/pagination/
328+
[cite]: https://docs.djangoproject.com/en/stable/topics/pagination/
329329
[github-link-pagination]: https://developer.github.com/guides/traversing-with-pagination/
330330
[link-header]: ../img/link-header-pagination.png
331331
[drf-extensions]: http://chibisov.github.io/drf-extensions/docs/

‎docs/api-guide/parsers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ Modify your REST framework settings.
224224

225225
[jquery-ajax]: http://api.jquery.com/jQuery.ajax/
226226
[cite]: https://groups.google.com/d/topic/django-developers/dxI4qVzrBY4/discussion
227-
[upload-handlers]: https://docs.djangoproject.com/en/dev/topics/http/file-uploads/#upload-handlers
227+
[upload-handlers]: https://docs.djangoproject.com/en/stable/topics/http/file-uploads/#upload-handlers
228228
[rest-framework-yaml]: http://jpadilla.github.io/django-rest-framework-yaml/
229229
[rest-framework-xml]: http://jpadilla.github.io/django-rest-framework-xml/
230230
[yaml]: http://www.yaml.org/

‎docs/api-guide/permissions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,8 +269,8 @@ The [Django Rest Framework Roles][django-rest-framework-roles] package makes it
269269
[authentication]: authentication.md
270270
[throttling]: throttling.md
271271
[filtering]: filtering.md
272-
[contribauth]: https://docs.djangoproject.com/en/dev/topics/auth/customizing/#custom-permissions
273-
[objectpermissions]: https://docs.djangoproject.com/en/dev/topics/auth/customizing/#handling-object-permissions
272+
[contribauth]: https://docs.djangoproject.com/en/stable/topics/auth/customizing/#custom-permissions
273+
[objectpermissions]: https://docs.djangoproject.com/en/stable/topics/auth/customizing/#handling-object-permissions
274274
[guardian]: https://github.com/lukaszb/django-guardian
275275
[get_objects_for_user]: http://pythonhosted.org/django-guardian/api/guardian.shortcuts.html#get-objects-for-user
276276
[2.2-announcement]: ../topics/2.2-announcement.md

‎docs/api-guide/relations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ For example, given the following model for a tag, which has a generic relationsh
505505
"""
506506
Tags arbitrary model instances using a generic relation.
507507

508-
See: https://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/
508+
See: https://docs.djangoproject.com/en/stable/ref/contrib/contenttypes/
509509
"""
510510
tag_name = models.SlugField()
511511
content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
@@ -593,9 +593,9 @@ The [drf-nested-routers package][drf-nested-routers] provides routers and relati
593593
The [rest-framework-generic-relations][drf-nested-relations] library provides read/write serialization for generic foreign keys.
594594

595595
[cite]: http://lwn.net/Articles/193245/
596-
[reverse-relationships]: https://docs.djangoproject.com/en/dev/topics/db/queries/#following-relationships-backward
596+
[reverse-relationships]: https://docs.djangoproject.com/en/stable/topics/db/queries/#following-relationships-backward
597597
[routers]: http://www.django-rest-framework.org/api-guide/routers#defaultrouter
598-
[generic-relations]: https://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/#id1
598+
[generic-relations]: https://docs.djangoproject.com/en/stable/ref/contrib/contenttypes/#id1
599599
[2.2-announcement]: ../topics/2.2-announcement.md
600600
[drf-nested-routers]: https://github.com/alanjds/drf-nested-routers
601601
[drf-nested-relations]: https://github.com/Ian-Foote/rest-framework-generic-relations

‎docs/api-guide/renderers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ Comma-separated values are a plain-text tabular data format, that can be easily
476476
[Rest Framework Latex] provides a renderer that outputs PDFs using Laulatex. It is maintained by [Pebble (S/F Software)][mypebble].
477477

478478

479-
[cite]: https://docs.djangoproject.com/en/dev/ref/template-response/#the-rendering-process
479+
[cite]: https://docs.djangoproject.com/en/stable/stable/template-response/#the-rendering-process
480480
[conneg]: content-negotiation.md
481481
[html-and-forms]: ../topics/html-and-forms.md
482482
[browser-accept-headers]: http://www.gethifi.com/blog/browser-rest-http-accept-headers
@@ -485,7 +485,7 @@ Comma-separated values are a plain-text tabular data format, that can be easily
485485
[quote]: http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
486486
[application/vnd.github+json]: http://developer.github.com/v3/media/
487487
[application/vnd.collection+json]: http://www.amundsen.com/media-types/collection/
488-
[django-error-views]: https://docs.djangoproject.com/en/dev/topics/http/views/#customizing-error-views
488+
[django-error-views]: https://docs.djangoproject.com/en/stable/topics/http/views/#customizing-error-views
489489
[rest-framework-jsonp]: http://jpadilla.github.io/django-rest-framework-jsonp/
490490
[cors]: http://www.w3.org/TR/cors/
491491
[cors-docs]: http://www.django-rest-framework.org/topics/ajax-csrf-cors/

‎docs/api-guide/responses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,5 @@ As with any other `TemplateResponse`, this method is called to render the serial
9191

9292
You won't typically need to call `.render()` yourself, as it's handled by Django's standard response cycle.
9393

94-
[cite]: https://docs.djangoproject.com/en/dev/ref/template-response/
94+
[cite]: https://docs.djangoproject.com/en/stable/stable/template-response/
9595
[statuscodes]: status-codes.md

0 commit comments

Comments
 (0)
0