You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: docs/topics/documenting-your-api.md
+1-17
Original file line number
Diff line number
Diff line change
@@ -195,18 +195,6 @@ This also translates into a very useful interactive documentation viewer in the
195
195
196
196
---
197
197
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
-
210
198
#### Django REST Swagger
211
199
212
200
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.
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.
217
205
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.
0 commit comments