Skip to main content

patch for Documentation for Web APIs made with Django Rest Framework.

Project description

# [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](

> **Contributors Wanted**: Do you like this project? Using it? Let's make it better!


### 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
'LOGIN_REQUIRED': True, # Default: True

### 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.





Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for drfdocs-louielu, version 0.0.11
Filename, size File type Python version Upload date Hashes
Filename, size drfdocs-louielu-0.0.11.tar.gz (773.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page