Kien Dang
f85d8cb81a
Fix comment syntax error in doc that fails pre-commit blacken-docs ( #9225 )
...
* Fix comment syntax in doc
* Pre-commit
2024-01-24 22:44:46 +01:00
Code Apprentice
047bec1288
Add documentation to show how to add authentication for the browseable api ( #9137 )
2024-01-04 14:16:57 +00:00
Yousef Abu Shanab
530baa23cd
Add 2 customization packages, rest-framework-redesign and rest-framework-material ( #9088 )
2024-01-04 12:42:54 +00:00
J.V. Zammit
e794e5e5e4
blacken-docs ( #8906 )
...
* blacken-docs: Manual fixes for command to pass without errors
* blacken-docs: Adds blacken-docs step to precommit hook.
* blacken-docs: Adds changes made by command itself.
* blacken-docs: Modifies blacken-docs step to only process files under "docs" directory
* blacken-docs: Updates pre-commit config file to exclude all directories other than "docs" to be compatible with "--all-files" flag.
* blacken-docs: Adds commas at the end to make it look identical to pre-black version
2023-10-13 12:44:45 +01:00
Marcelo Galigniana
605cc4f736
Updated links to CSRF/AJAX Django documentation ( #9118 )
2023-09-29 15:06:16 +06:00
T. Franzel
f0095b4de2
Remove Core API mentions from docs ( #8780 )
...
* remove coreapi generator mentions & hidden docs
* remove coreapi doc & redirect broken links to github snapshot
2022-11-28 14:41:08 +01:00
T. Franzel
b87699c034
Update schema generation doc & add deprecation notice #8453 ( #8773 )
...
* Update schema generation doc & add deprecation notice #8453
* Update docs/topics/documenting-your-api.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
* Update docs/topics/documenting-your-api.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
* Update docs/topics/documenting-your-api.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
Co-authored-by: T. Franzel <13507857+tfranzel@users.noreply.github.com>
Co-authored-by: Asif Saif Uddin <auvipy@gmail.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>
2022-11-22 19:53:54 +06:00
Francisco Couzo
041b88f8bb
Improve style, fix some typos ( #8405 )
...
* Improve style, fix some typos
* Update docs/api-guide/fields.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>
2022-10-19 11:20:11 +01:00
Elton Maiyo
e354331743
Fixes typo ( #8719 )
2022-10-19 11:11:09 +01:00
mschmidm
99cf2c415f
Docs: Updated browsable-api.md ( #8678 )
...
- Replace the broken Bootswatch-Link with an Jsdelivr-Link as suggested at https://bootswatch.com/help/
- Updated the stated Bootstrap version
- Added a note that the Bootstrap version must match the default one
Co-authored-by: Tom Christie <tom@tomchristie.com>
2022-10-04 12:15:51 +01:00
denniskloyn
02eeb6fa00
Change MIDDLEWARE_CLASSES
to MIDDLEWARE
( #8333 )
...
The `MIDDLEWARE_CLASSES` setting got changed to `MIDDLEWARE` in [Django 1.10](https://docs.djangoproject.com/en/1.10/topics/http/middleware/ ).
2022-01-18 08:52:11 +00:00
Jaap Roes
dabf2216c3
Update django-cors-headers links ( #8176 )
2021-12-08 14:30:34 +00:00
Romain Rigaux
750bad0a58
Actually use the loginUser arguments in the example ( #7714 )
2021-03-09 12:00:51 +00:00
Jean-Pierre Merx
234527959d
Have options example in documenting-your-api.md to return a Response ( #7639 )
...
It was returning data which is not correct. Closes #7638 .
Co-authored-by: Jean-Pierre Merx <jean-pierre.merx@aictivate.com>
2021-03-08 12:08:26 +00:00
Karol Onyśko
96993d817a
Changed url to django docs so it points to the stable version ( #7628 )
...
Co-authored-by: Karol Onyśko <karol.onysko@cic.com>
2020-11-12 18:42:42 +01:00
Xavier Ordoquy
2e721cdbc8
Merge pull request #7436 from markstory/patch-1
...
Fix broken links in documenting API section
2020-10-06 22:26:22 +02:00
T. Franzel
c6e24521da
Add third-party schema library drf-spectacular to docs ( #7540 )
...
Co-authored-by: T. Franzel <13507857+tfranzel@users.noreply.github.com>
2020-09-21 11:39:35 +01:00
Adam Johnson
410575dace
Replace all url() calls with path() or re_path() ( #7512 )
...
* url() is deprecated in Django 3.1
* update given feedbacks on url() is deprecated in Django 3.1
* Fix test_urlpatterns.py to continue testing mixed re_path() and path()
* Fix one missed reference
Co-authored-by: sanjusci <sanju.sci9@gmail.com>
2020-09-08 15:32:27 +01:00
Vibhu Agarwal
3d708ac700
Fix broken docs link ( #7473 )
2020-08-11 16:36:23 -07:00
Mark Story
30ca04df83
Fix broken links in documenting API section
...
The changed links were not working on the documentation site. I'm not 100% sure that these changes are correct but they generate working links in the GitHub previews.
2020-07-29 09:58:53 -04:00
phankiewicz
a9e55334e7
Add X-CSRFToken HTTP header in swagger-ui example ( #6968 )
2020-01-03 13:59:32 +00:00
Jihoon Park
f3ed69374d
Add missing punctuation marks and URL name ( #7108 )
...
- trailing commas (as both Python and JavaScript allow them)
- trailing semicolons in JavaScript
- URL name `api-docs`
2020-01-03 13:28:35 +00:00
James
323e1cddda
Cleanup "Documenting your API" 3rd party recommendations ( #7057 )
2019-11-15 18:39:47 -08:00
Chris Guo
a734e58d44
Fix docs typos ( #7006 )
2019-10-21 15:11:12 -07:00
David Sanders
9850441e6f
Fix docs typo ( #6974 )
2019-10-08 16:37:58 -07:00
Min ho Kim
0e1c5d3132
Fix typos ( #6835 )
2019-07-25 10:04:01 -07:00
Luke Plant
f0dbf0a264
Update docs to use lists instead of tuples ( #6797 )
2019-07-12 18:15:36 -07:00
Carlton Gibson
7915485c0d
Update docs for OpenAPI. ( #6668 )
...
* Update schema docs for OpenAPI
* Begin v3.10 Release Announcement.
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
2019-07-08 13:09:05 +01:00
Étienne Noss
f5470ab9e2
docs: update http method override middleware example ( #6776 )
2019-07-03 10:23:35 +01:00
Aart Goossens
0f819d844d
Remove recommendation for DRF Docs ( #6580 )
...
Since DRF Docs is not compatible with the latest version of DRF (or Django?; related issue: https://github.com/manosim/django-rest-framework-docs/issues/180 ) and the latest release is almost 3 years ago I suggest to remove the recommendation for this package.
2019-05-03 15:26:06 -07:00
Jimmy Merrild Krag
14fad0d690
Fix capitalization, markdown syntax link in docs ( #6621 )
...
The `Pygments` and `Markdown` python packages have first letter capital.
Fixed link to markdown syntax to go directly to the syntax page.
2019-05-02 18:17:33 -07:00
Carlton Gibson
d932baa646
Corrected link to ajax-form library.
...
Closes #6465 .
2019-02-22 11:11:52 +01:00
Cyrus Ghazanfar
7ad5bdb669
Adjusted login template override example ( #6265 )
2018-12-19 15:25:34 +01:00
Stephen Finucane
fae7e91728
docs: Remove references to drf-openapi ( #6272 )
...
This has been EOL'd in favour of drf-yasg [1].
[1] https://github.com/limdauto/drf_openapi/commit/1673c6e0
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-03 15:57:47 +01:00
Daniel Bate
5feb835929
Feature/action docs sections ( #6060 )
...
* added ability to add sections to custom action documentation
* added tests to cover docs sections in custom actions
* added method specific docs test for action mapping
* added docs for custom action documentation
2018-10-10 10:29:29 +02:00
Jon Dufresne
878f9d2783
Prefer https:// for URLs when available throughout project ( #6208 )
2018-10-02 08:28:58 +02:00
Melissa Lewis
b090ae9d30
Fix docs typos ( #6195 )
2018-09-18 15:32:32 -07:00
Eze Sunday
a0277919f0
Fix grammar mistake in html-and-forms.md ( #6070 )
2018-07-08 16:11:05 -04:00
Ryan P Kilby
99ca078ebb
Add "Community" section to docs, minor cleanup ( #5993 )
...
* Add 'Community' tab to navigation, move articles
* Drop DRF 2.x announcements and the docs note
* Drop embedded tutorial/guide/topics links
* Conver mixture of tabs/spaces => spaces
* Fix topics/community links
2018-07-06 11:28:18 +02:00
Ryan P Kilby
7095021db7
Rename base_name => basename for consistency's sake ( #5990 )
...
* Rename base_name => basename for consistency
* Update tests to use basename
2018-07-06 11:03:12 +02:00
William S. Vincent
feffa109a8
Add REST APIs with Django book ( #6033 )
...
Just published book dedicated to DRF.
2018-06-20 00:24:26 +01:00
Jon Dufresne
89fb0b0f99
Update incorrect PyPI URL to register an account
...
To register an account on PyPI, the URL is
https://pypi.org/account/register/ , which changed after the move to
pypi.org.
2018-06-09 19:09:31 -07:00
John Franey
f20e282d15
Update documenting-your-api.md ( #5991 )
...
Fix link to "Schemas as Documentation: Examples"
2018-05-17 00:36:41 -04:00
Ari Rouvinen
45acfe05b4
Add missing comma ( #5978 )
2018-05-08 09:15:59 +01:00
Andreas Lutro
a6b6b6ce55
remove references to DOAC in docs ( #5977 )
...
Project has been archived on github and recommends alternative.
2018-05-08 09:10:43 +01:00
Jochen Wersdörfer
c4676510fd
Adjusted client JWT example ( #5944 )
2018-04-20 15:33:59 +02:00
Jon Dufresne
8c47a875ec
Update all pypi.python.org URLs to pypi.org ( #5942 )
...
For details on the new PyPI, see the blog post:
https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
2018-04-19 08:36:18 +02:00
Arne Schauf
d5fe1f66ac
Fix a typo in the 3.8 announcement ( #5940 )
2018-04-18 06:36:03 +01:00
David Jean Louis
1c53fd3212
Added djangorestframework-datatables to third-party packages ( #5931 )
2018-04-10 13:25:20 +01:00
Anna Ossowski
0178d3063d
Added 3.8 release + updated monthly report link
2018-04-08 21:47:50 +02:00