Skip to content

Commit 4ba90dc

Browse files
committed
Remove recommendation for DRF Docs
Since DRF Docs is not compatible with the latest version of DRF (or Django?; related issue: manosim/django-rest-framework-docs#180) and the latest release is almost 3 years ago I suggest to remove the recommendation for this package.
1 parent 29cbe57 commit 4ba90dc

File tree

2 files changed

+1
-17
lines changed

2 files changed

+1
-17
lines changed

docs/img/drfdocs.png

-567 KB
Binary file not shown.

docs/topics/documenting-your-api.md

+1-17
Original file line numberDiff line numberDiff line change
@@ -195,18 +195,6 @@ This also translates into a very useful interactive documentation viewer in the
195195

196196
---
197197

198-
#### DRF Docs
199-
200-
[DRF Docs][drfdocs-repo] allows you to document Web APIs made with Django REST Framework and it is authored by Emmanouil Konstantinidis. It's made to work out of the box and its setup should not take more than a couple of minutes. Complete documentation can be found on the [website][drfdocs-website] while there is also a [demo][drfdocs-demo] available for people to see what it looks like. **Live API Endpoints** allow you to utilize the endpoints from within the documentation in a neat way.
201-
202-
Features include customizing the template with your branding, settings for hiding the docs depending on the environment and more.
203-
204-
Both this package and Django REST Swagger are fully documented, well supported, and come highly recommended.
205-
206-
![Screenshot - DRF docs][image-drf-docs]
207-
208-
---
209-
210198
#### Django REST Swagger
211199

212200
Marc Gibbons' [Django REST Swagger][django-rest-swagger] integrates REST framework with the [Swagger][swagger] API documentation tool. The package produces well presented API documentation, and includes interactive tools for testing API endpoints.
@@ -215,7 +203,7 @@ Django REST Swagger supports REST framework versions 2.3 and above.
215203

216204
Mark is also the author of the [REST Framework Docs][rest-framework-docs] package which offers clean, simple autogenerated documentation for your API but is deprecated and has moved to Django REST Swagger.
217205

218-
Both this package and DRF docs are fully documented, well supported, and come highly recommended.
206+
This package is fully documented, well supported, and comes highly recommended.
219207

220208
![Screenshot - Django REST Swagger][image-django-rest-swagger]
221209

@@ -322,9 +310,6 @@ To implement a hypermedia API you'll need to decide on an appropriate media type
322310
[cite]: https://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
323311
[drf-yasg]: https://github.com/axnsan12/drf-yasg/
324312
[image-drf-yasg]: ../img/drf-yasg.png
325-
[drfdocs-repo]: https://github.com/ekonstantinidis/django-rest-framework-docs
326-
[drfdocs-website]: https://www.drfdocs.com/
327-
[drfdocs-demo]: http://demo.drfdocs.com/
328313
[drfautodocs-repo]: https://github.com/iMakedonsky/drf-autodocs
329314
[django-rest-swagger]: https://github.com/marcgibbons/django-rest-swagger
330315
[swagger]: https://swagger.io/
@@ -333,7 +318,6 @@ To implement a hypermedia API you'll need to decide on an appropriate media type
333318
[apiary]: https://apiary.io/
334319
[markdown]: https://daringfireball.net/projects/markdown/
335320
[hypermedia-docs]: rest-hypermedia-hateoas.md
336-
[image-drf-docs]: ../img/drfdocs.png
337321
[image-django-rest-swagger]: ../img/django-rest-swagger.png
338322
[image-apiary]: ../img/apiary.png
339323
[image-self-describing-api]: ../img/self-describing.png

0 commit comments

Comments
 (0)