Skip to content

manosim/django-rest-framework-docs

Repository files navigation

Django Rest Framework Docs travis pypi

Document Web APIs made with Django Rest Framework.

Prerequisites

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

Development

pyvenv env env/bin/pip install -r requirements.txt # To test within another django project pip install -e ~/Projects/drf-docs/ 

Installation

Install using pip:

pip install djangorestframeworkdocs 

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', app_name='rest_framework_docs', namespace='rest_framework_docs')), ] 

About

Document Web APIs made with Django Rest Framework

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 17