Commit Graph

965 Commits

Author SHA1 Message Date
Jon Dufresne
d3f3c3d9c1 Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
Jon Dufresne
d5c34aa813 Remove unused links from docs (#5735)
Each removed link has no inline use.
2018-01-15 15:03:44 +01:00
Jon Dufresne
b2ec681d8d Pass python_requires argument to setuptools (#5739)
Helps pip decide what version of the library to install.

https://packaging.python.org/tutorials/distributing-packages/#python-requires

> If your project only runs on certain Python versions, setting the
> python_requires argument to the appropriate PEP 440 version specifier
> string will prevent pip from installing the project on other Python
> versions.

https://setuptools.readthedocs.io/en/latest/setuptools.html#new-and-changed-setup-keywords

> python_requires
>
> A string corresponding to a version specifier (as defined in PEP 440)
> for the Python version, used to specify the Requires-Python defined in
> PEP 345.
2018-01-11 08:51:34 +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
Bruno Alla
832267e945 Fix formatting of the 3.7.4 release note (#5704) 2017-12-22 08:28:35 +01:00
Xavier Ordoquy
955a6b902b Add 3.7.7 release notes 2017-12-21 12:45:54 +01:00
Tom Christie
65791d8c79 Version 3.7.5. Add missing .ico to packaging. 2017-12-21 10:17:59 +00:00
Tom Christie
0d96be9266 Add 3.7.5 release notes 2017-12-21 10:13:18 +00:00
Carlton Gibson
a81e60ff39
Version 3.7.4 Release (#5650)
* Update version for 3.7.4 Release

* Add release notes to 01587b9eb1

* Django 2.0 is now final.

* Add trove classifer for Django 2.0

* Finalise release notes for v3.7.4

* Set release date: December 20, 2017

* Update Transifex

* Add release note for #5691

* Move Issue links to bottom
2017-12-20 15:28:31 +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
Anna Ossowski
1692feb535
Updated monthly report link 2017-12-06 03:10:41 +01:00
Carlton Gibson
a0cdba6277
Extract method for manual_fields processing (#5633)
* Extract method for `manual_fields` processing

Allows reuse of logic to replace Field instances in a field list by `Field.name`.

Adds a utility function for the logic plus a wrapper method on `AutoSchema`.

Closes #5632

* Manual fields suggestions (#2)

* Use OrderedDict in inspectors

* Move empty check to 'update_fields()'

* Make 'update_fields()' an AutoSchema staticmethod

* Add 'AutoSchema.get_manual_fields()'

* Conform '.get_manual_fields()' to other methods

* Add test for update_fields

* Make sure `manual_fields` is a list.

(As documented to be)

* Add docs for new AutoSchema methods.

* `get_manual_fields`
* `update_fields`

* Add release notes for PR.
2017-12-04 09:07:43 +01:00
Carlton Gibson
97f7a82b37 Correct typos
Closes #5634
2017-11-28 16:46:34 +01:00
Anna Ossowski
c33d0069da
Updated monthly report link + added 3.7 info 2017-11-10 19:27:26 +01:00
Jon Dufresne
f9c67f04d4 Clean up all whitespace throughout project (#5578)
* Remove trailing whitespace from lines
* Remove trailing nad leading whitespace from files

Allows for cleaner diffs in future changes. For editors that
automatically clean up whitespace on save, will avoid unrelated line
changes in diffs.
2017-11-09 20:57:53 +01:00
Carlton Gibson
0f33e63e10
Update version and release notes for v3.7.3 (#5568) 2017-11-06 16:32:12 +01:00
Carlton Gibson
3dc40f9572
Version 3.7.2 Release (#5563)
* Begin release notes for 3.7.2

* Add release notes fro merged issues.

* Finalise release notes

* Increment version number to 3.7.2

* Update translations
2017-11-06 12:05:08 +01:00
Allisson Azevedo
3ddc22f708 Add djangorestframework-rapidjson to third party packages (#5549) 2017-11-02 10:19:33 +01:00
Carlton Gibson
80320ed615 Version 3.7.1 Release (#5505)
* Release notes for 3.7.1

* Update version to 3.7.1
2017-10-16 15:11:54 +02:00
Matthew Egan
e39d9337da Version 3.7 annoucement fix (#5501) 2017-10-15 21:51:55 +02:00
Ed Morley
22565d9a65 Docs: Fix a few typos in the release notes and tutorial (#5483) 2017-10-06 15:46:42 +01:00
Carlton Gibson
eb3d078a2c Version 3.7: Announcement etc (#5437)
* Set version number for 3.7.0 release

* Rename release notes section

Moved issue links to top for easier access.
(Can move back later)

* Add release note for #5273

* Add release note for #5440

* Add release note for #5265

Strict JSON handling

* Add release note for #5250

* Add release notes for #5170

* Add release notes for #5443

* Add release notes for #5448

* Add release notes for #5452

* Add release not for #5342

* Add release notes for 5454

* Add release notes for #5058 & #5457

Remove Django 1.8 & 1.9 from README and setup.py

* Release notes for merged 3.6.5 milestone tickets

Tickets migrated to 3.7.0 milestone.

* Add release notes for #5469

* Add release notes from AM 2ndOct

* Add final changes to the release notes.

* Add date and milestone link

Move issue links back to bottom.

* Update translations from transifex

* Begin releae anouncement

* Add release note for #5482

* 3.7 release announcement & related docs.
2017-10-06 13:18:31 +02:00
Carlton Gibson
d8da6bb29b Update coreapi JS to 0.1.1 (#5479)
Ref #5059
2017-10-05 13:40:28 +02:00
Carlton Gibson
2befa6c316 Document documentation.py (#5478)
Closes #5198. Closes #5142. Closes #4980
2017-10-04 12:12:06 +02:00
Tom Christie
5dcb460793 Update link to monthly report.
Closes #5474.
2017-10-03 12:15:52 +01: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
Carlton Gibson
cb6e7e0fdd Drop erroneous ) in release notes 2017-09-20 14:23:51 +02:00
Carlton Gibson
7d6d043531 Fix DateTimeField TZ handling (#5435)
* Add failing TZ tests for DateTimeField

- tests "current" timezone activation
- tests output for non-UTC timezones

* Update DateTimeField TZ aware/naive test output

* Fix DateTimeField TZ handling

* Add Release Note for BC change
2017-09-20 12:15:15 +02:00
Carlton Gibson
7b1582e00e Allow schema = None. Deprecate exclude_from_schema (#5422)
* Add tests for schema exclusions

* Move exclusion check to should_include_endpoint

* Update docs

* Switch to using `schema = None`

* Test PendingDeprecationWarnings

* Add note to release notes.

* s/deprecated/pending deprecation/

* Add PR link to release notes

* Correct typo in test class name

* Test 'exclude_from_schema' deprecation warning message (#1)

* Correct deprecation warning message
2017-09-20 11:29:47 +02:00
Ryan P Kilby
af460d2b69 Add PR 5376 to release notes 2017-09-01 13:37:06 -04:00
Ashish Patil
26d4977cd0 ~api-clients documentation: installation code fix 2017-08-24 15:06:48 +04:00
Carlton Gibson
0a0bb6a871 Update release notes
For the last minute #5346
2017-08-21 20:33:51 +02:00
Carlton Gibson
81527a2863 Release notes for 3.6.4 2017-08-21 11:50:00 +02:00
Carlton Gibson
3110635685 Update JS constructor syntax (#5332)
Fixes #5247
2017-08-15 14:33:06 +01:00
Vašek Dohnal
1f2e2dea96 Fixed typo in docs/Documenting your API (#5316) 2017-08-08 10:01:19 -04:00
Anna Ossowski
21074a02b4 Changed monthly report link (#5308)
* Removed Micropyramid as a sponsor

* Changed monthly report link
2017-08-04 15:23:54 -04:00
David Sanders
4091607d94 Add information in docs about djangorestframework-simplejwt package 2017-07-05 14:48:54 -06:00
Anna
fd6cc1e395 Updated monthly report link 2017-07-04 17:53:03 +02:00
Anna
462378ba99 Added FAQ section for funding site 2017-06-15 19:02:40 +02:00
Anna
b296d3b9a3 Updated monthly report link + added Tom's PyCon talk 2017-06-05 18:19:03 +02:00
Matt Broach
e4ec1d744e Updated DjangoRestMulipleModel documentation to point to new repo location 2017-05-30 23:39:18 -04:00
Tom Christie
996e587398 Remove broken bit of merge commit 2017-05-12 18:25:06 +01:00
Tom Christie
cdd15f3769 Remove broken bit of merge commit 2017-05-12 18:23:35 +01:00
Tom Christie
a99f12f1c6 Merge branch 'master' into version-3-6-3 2017-05-12 17:03:32 +01:00
Tom Christie
42f80c65a9 Version 3.6.3 2017-05-12 16:52:27 +01:00
Tom Christie
67f382394b Update third-party-packages.md 2017-05-03 09:25:40 +01:00
Tom Christie
e7483133ea Update browsable-api.md 2017-05-01 11:49:42 +01:00
José Padilla
d45c12ff8c
Improve books section 2017-04-26 09:16:45 -04:00
José Padilla
fff9837195 Merge pull request #5098 from pydanny/fix-book-order
Corrected order of books. Apologies to @limedaring
2017-04-25 21:31:39 -04:00
Daniel Roy Greenfeld
dfb0e6ff2d Corrected order of books. Apologies to @limedaring 2017-04-25 17:42:14 -07:00
Daniel Roy Greenfeld
4be21cf854 add Two Scoops of Django 1.11 to tutorials and resources 2017-04-25 14:36:36 -07:00
Anna
1bbfc0e87c Updated monthly report link on funding page 2017-04-10 22:37:49 +02:00
José Padilla
c1f31492ae
Update links after moving to encode org 2017-04-07 10:28:35 -04:00
aaronykng
10d8ad601c Added drfpasswordless to third party packages topic page. 2017-03-27 07:27:46 -07:00
Tom Christie
63a4021472 Add whitespace between user quotes on funding page 2017-03-27 11:18:20 +01:00
Anna
6a8aed03a8 Updated testimonial name on funding site 2017-03-16 06:00:57 +01:00
Anna
ade7a254d5 Fixed mistakes for funding page PR 2017-03-10 23:06:01 +01:00
Anna
628c356832 Merge remote-tracking branch 'upstream/master' 2017-03-10 22:28:20 +01:00
Tom Christie
1d34bc0b92 Update release notes 2017-03-10 14:38:24 +00:00
Tom Christie
0fe0a91aed Remove erronous HTML in example. Closes #4958 2017-03-10 08:51:19 +00:00
Anna
60bb3b0958 Updated funding page 2017-03-10 06:30:31 +01:00
Tom Christie
1d4290eb7b Tweak docs 2017-03-09 15:59:29 +00:00
Tom Christie
86931b01b6 Note dependancies in docs 2017-03-09 14:59:00 +00:00
Tom Christie
52db57a6e7 Version 3.6 (#4943) 2017-03-09 14:49:51 +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
Anna
ff4f252003 Fixed broken mail link in tutorials and resources 2017-03-03 00:40:57 +01:00
Binoj David
d58c89adc1 Fix Schemas Example URL 2017-02-28 22:45:17 +05:30
José Padilla
b936d829a6 Fix mailto link (#4923) 2017-02-26 09:08:03 +00:00
Anna Ossowski
e922d91614 Created Tutorials and Resources, cleaned up Third Party Packages (#4910)
* Updated Support section and added funding email
* Created new tutorials and resources section, cleaned up third party packages section
* Created Jobs section
2017-02-24 12:55:34 +00:00
Tom Christie
eb5774229f Version 3.5.4 (#4894) 2017-02-10 11:15:39 +00:00
Anna Ossowski
a8dbc22028 Updated Support section and added funding email (#4860) 2017-01-28 22:41:21 +00:00
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
Artem Muterko
b352c8a24c Fix some typos in documentation 2017-01-08 15:34:52 +02:00
Tom Christie
cf3862d56d Update 3.0-announcement.md
Closes #4785
2017-01-06 07:24:28 +00:00
wim glenn
718764f591 add links to djangorestframework-queryfields to docs (#4786) 2017-01-06 06:40:50 +00:00
Ian Clark
eddc34f4c8 Add Serializer Extensions documentation (#4777) 2017-01-04 08:40:42 +00:00
Makedonsky
69366a11d7 modify documenting-your-api docs topic 2017-01-03 13:17:07 +02:00
Allard Hoeve
0175ea4809 Add drf-oidc-auth to 3rd party mods 2016-12-14 20:15:39 +01:00
Xavier Ordoquy
22578525ef Documentation update (#4717) 2016-11-30 12:58:34 +00:00
Tom Christie
ea60872e9e Version 3.5.3 [ci skip] 2016-11-07 13:38:48 +00:00
James Beith
befacfb00d Add autofocus support for input.html templates (#4650)
This change adds support to use `'autofocus': True` in the style options and have the `autofocus` attribute included on the input field when rendered.
2016-11-07 11:34:53 +00:00
pkrzyzaniak
7f437123bd Added "drf_tweaks" to third party packages (#4659) 2016-11-06 22:12:52 +00:00
Tom Christie
2bf082a623 Version 3.5.2 [ci skip] (#4641) 2016-11-01 11:31:20 +00:00
Tom Christie
3b39d2d13a Version 3.5.1 [ci skip] 2016-10-21 17:10:38 +01:00
Maxime Lorant
1aa6dff0b5 Fix code formatting missing in 3.5 announcement (#4597)
... in section ModelSerializer 'fields' and 'exclude'
2016-10-20 16:47:59 +01:00
Tom Christie
3b9afb571b Version 3.5.0 (#4596) 2016-10-20 16:25:40 +01:00
Akshay Sharma
cca9792ae7 contributing.md django fix. (#4581)
* installation for django added in requirements.txt
* added line to install django first in contributing.md

* added line to install django first in contributing.md and CONTRIBUTING.md
2016-10-14 11:20:09 +01:00
Tom Christie
4c9b14bd97 Add --minimum-perc to transifex pull command [ci skip] 2016-10-12 10:13:46 +01:00
Manjit Kumar
d49e26f127 add drf-url-filters in third party filtering resources and fixed typo (#4548) 2016-10-10 12:35:38 +01:00
Tom Christie
7ab4a587d9 Version 3.4.7 (#4501) 2016-09-21 12:24:26 +01:00
Tom Christie
f064ec6ac6 Version 3.4.6 (#4436) 2016-08-23 16:59:47 +01:00
Tom Christie
63342e81db Version 3.4.5 (#4421) 2016-08-19 12:45:20 +01:00
Tom Christie
964f82528c Tweak formatting in release notes [ci skip] 2016-08-12 12:13:56 +01:00
Tom Christie
a7525d838a Version 3.4.4 (#4395) 2016-08-12 12:08:25 +01:00
Tom Christie
bb613c5ad1 Version 3.4.3 (#4361)
* Version 3.4.3
2016-08-05 13:33:25 +01:00
Tom Christie
35320b1f2d Add bullet points to release notes [ci skip] 2016-08-05 12:41:15 +01:00
Tom Christie
f9cf22edc8 Version 3.4.2 (#4360) 2016-08-05 12:38:19 +01:00
Tom Christie
48a2f084aa Minor docs tweak [ci skip] 2016-07-28 13:38:05 +01:00