From 471fdc510d6bd682436344db09cf0c28246d08bd Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Sun, 9 Apr 2017 14:23:35 -0400 Subject: [PATCH] Update install docs w/ django setting (#678) --- README.rst | 14 +++++++++----- docs/guide/install.txt | 7 +++++++ 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index c7c98e64a..da3c4e4c2 100644 --- a/README.rst +++ b/README.rst @@ -8,9 +8,9 @@ Full documentation on `read the docs`_. .. image:: https://travis-ci.org/carltongibson/django-filter.svg?branch=master :target: https://travis-ci.org/carltongibson/django-filter - + .. image:: https://codecov.io/gh/carltongibson/django-filter/branch/develop/graph/badge.svg - :target: https://codecov.io/gh/carltongibson/django-filter + :target: https://codecov.io/gh/carltongibson/django-filter .. image:: https://badge.fury.io/py/django-filter.svg :target: http://badge.fury.io/py/django-filter @@ -32,11 +32,15 @@ Install using pip: pip install django-filter -Or clone the repo and add to your ``PYTHONPATH``: +Then add ``'django_filters'`` to your ``INSTALLED_APPS``. -.. code-block:: sh +.. code-block:: python + + INSTALLED_APPS = [ + ... + 'django_filters', + ] - git clone git@github.com:carltongibson/django-filter.git Usage ----- diff --git a/docs/guide/install.txt b/docs/guide/install.txt index 2a58e2c85..246e58da3 100644 --- a/docs/guide/install.txt +++ b/docs/guide/install.txt @@ -10,6 +10,13 @@ Django-filter can be installed from PyPI with tools like ``pip``: Then add ``'django_filters'`` to your ``INSTALLED_APPS``. +.. code-block:: python + + INSTALLED_APPS = [ + ... + 'django_filters', + ] + Requirements ------------