skip to navigation
skip to content

drfdocs 0.0.11

Documentation for Web APIs made with Django Rest Framework.

# [DRF Docs]( [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![pypi][pypi-image]][pypi-url] [![slack][slack-image]][slack-url]

Document Web APIs made with Django Rest Framework. [View Demo](


### Supports

- Python (2.7, 3.3, 3.4, 3.5)
- Django (1.8, 1.9)
- Django Rest Framework (3+)

### Documentation - Table of contents

- [Installation](
- [Settings](
- [Extending the template](
- [Live API Endpoints](
- [Contributing & Development](
- [Changelog](

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

pyvenv env
env/bin/pip install -r requirements.txt
pip install -e ~/Projects/drf-docs/

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 [](demo/ of the demo project.

For more information visit [the docs](

### Installation

Install using pip:

pip install drfdocs

Add 'rest_framework_docs' to your `INSTALLED_APPS` setting:


Finally include the `rest_framework_docs` urls in your ``:

urlpatterns = [
url(r'^docs/', include('rest_framework_docs.urls')),

### Settings
You can find detailed information about the package's settings at [the docs](

'HIDE_DOCS': True # Default: False

### Credits

First of all thanks to the [Django]( core team and to all the contributors of [Django REST Framework]( for their amazing work. Also I would like to thank [Marc Gibbons]( for his *django-rest-framework-docs* project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ & Python 3.




File Type Py Version Uploaded on Size
drfdocs-0.0.11.tar.gz (md5) Source 2016-06-04 753KB