encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-26 11:33:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Note dependancies in docs

Browse Source
This commit is contained in:
Tom Christie 2017-03-09 14:59:00 +00:00
parent 52db57a6e7
commit 86931b01b6
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/topics/3.6-announcement.md
View File

@ -60,6 +60,10 @@ REST framework's new API documentation supports a number of features:
* Support for various authentication schemes. * Support for various authentication schemes.
* Code snippets for the Python, JavaScript, and Command Line clients. * Code snippets for the Python, JavaScript, and Command Line clients.
The `coreapi` library is required as a dependancy for the API docs. Make sure
to install the latest version (2.3.0 or above). The `pygments` and `markdown`
libraries are optional but recommended.
To install the API documentation, you'll need to include it in your projects URLconf: To install the API documentation, you'll need to include it in your projects URLconf:
from rest_framework.documentation import include_docs_urls from rest_framework.documentation import include_docs_urls
@ -147,6 +151,11 @@ For more information see the [Python client library documentation][py-docs].
## Deprecations ## Deprecations
### Updating `coreapi`
If you're using REST framework's schema generation, or want to use the API docs,
then you'll need to update to the latest version of coreapi. (2.3.0)
### Generating schemas from Router ### Generating schemas from Router
The 3.5 "pending deprecation" of router arguments for generating a schema view, such as `schema_title`, `schema_url` and `schema_renderers`, have now been escalated to a The 3.5 "pending deprecation" of router arguments for generating a schema view, such as `schema_title`, `schema_url` and `schema_renderers`, have now been escalated to a

4
docs/topics/documenting-your-api.md
View File

@ -16,6 +16,10 @@ The built-in API documentation includes:
### Installation ### Installation
The `coreapi` library is required as a dependancy for the API docs. Make sure
to install the latest version. The `pygments` and `markdown` libraries
are optional but recommended.
To install the API documentation, you'll need to include it in your projects URLconf: To install the API documentation, you'll need to include it in your projects URLconf:
from rest_framework.documentation import include_docs_urls from rest_framework.documentation import include_docs_urls