Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ Document Web APIs made with Django Rest Framework.
- Django Rest Framework (3+)


### Documentation - Table of contents

- [Installation](http://drfdocs.com/docs/installation/)
- [Settings](http://drfdocs.com/docs/settings/)
- [Extending the template](http://drfdocs.com/docs/templates/)
- [Contributing & Development](http://drfdocs.com/docs/contributing/)
- [Changelog](http://drfdocs.com/docs/changelog/)


### Development & Demo Project
If you are looking to develop this package with one of your own django projects:

Expand All @@ -21,6 +30,8 @@ If you are looking to develop this package with one of your own django projects:
If you want to use the demo app to work on this package:
Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please check the [README.md](demo/README.md) of the demo project.

For more information visit [the docs](http://drfdocs.com/docs/contributing/).

### Installation

Install using pip:
Expand All @@ -43,6 +54,7 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:


### Settings
You can find detailed information about the package's settings at [the docs](http://drfdocs.com/docs/settings/).

REST_FRAMEWORK_DOCS = {
'HIDDEN': True # Default: False
Expand Down