From 26dc65481896d7bd1955afd29ea91f2b91892a19 Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Sun, 10 Jan 2010 18:07:46 +0000 Subject: [PATCH] Fixed #11884 -- Clarified documentation to explain how to activate the built-in admin reference. Thanks, DmitryRisenberg and timo git-svn-id: http://code.djangoproject.com/svn/django/trunk@12178 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/topics/templates.txt | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/topics/templates.txt b/docs/topics/templates.txt index 41cb94a56d..9fa6c44dc9 100644 --- a/docs/topics/templates.txt +++ b/docs/topics/templates.txt @@ -577,8 +577,18 @@ Using the built-in reference ============================ Django's admin interface includes a complete reference of all template tags and -filters available for a given site. To see it, go to your admin interface and -click the "Documentation" link in the upper right of the page. +filters available for a given site. To activate it, follow these steps: + + * Add :mod:`django.contrib.admindocs` to your :setting:`INSTALLED_APPS`. + * Add ``(r'^admin/doc/', include('django.contrib.admindocs.urls'))`` to your + :data:`urlpatterns`. Make sure it's included *before* the ``r'^admin/'`` + entry, so that requests to ``/admin/doc/`` don't get handled by the + latter entry. + * Install the docutils module (http://docutils.sf.net/). + +After you've followed those steps, you can start browsing the documentation by +going to your admin interface and clicking the "Documentation" link in the +upper right of the page. The reference is divided into 4 sections: tags, filters, models, and views.