Skip to content
Document Web APIs made with Django Rest Framework
Python JavaScript HTML CSS
Branch: master
Clone or download

Latest commit

manosim Merge pull request #152 from xncbf/patch-1
Fix typo in documentation
Latest commit 94571d0 Feb 7, 2017

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo Remove empty get_object method from RetrieveOrganisationView Jun 29, 2016
docs Fix typo in documentation Feb 7, 2017
rest_framework_docs Merge branch 'master' into local. Dec 23, 2016
tests Typo. Jan 25, 2017
.gitignore Adding nested serializers support for many=True relations Jun 28, 2016
.travis.yml Travis Cache May 25, 2016
LICENSE Initial Commit Dec 11, 2015
MANIFEST.in Exclude docs in pypi Feb 27, 2016
README.md Minor Changes Aug 28, 2016
codecov.yml Codecov Settings May 25, 2016
mkdocs.yml Update docs Aug 28, 2016
requirements.txt Init MKdocs Feb 27, 2016
runtests.py Move npm install to .travis.yml Dec 25, 2015
setup.cfg Create setup.cfg Jul 1, 2016
setup.py Rename Pypi Package Dec 18, 2015

README.md

DRF Docs travis codecov pypi slack

Document Web APIs made with Django Rest Framework. View Demo

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

DRFdocs

Supports

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

Documentation - Table of contents

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 README.md 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:

INSTALLED_APPS = (
    ...
    'rest_framework_docs',
)

Finally include the rest_framework_docs urls in your urls.py:

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

Settings

You can find detailed information about the package's settings at the docs.

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

You can’t perform that action at this time.