Permalink
Browse files

Fixed #11884 -- Clarified documentation to explain how to activate th…

…e built-in admin reference. Thanks, DmitryRisenberg and timo

git-svn-id: http://code.djangoproject.com/svn/django/trunk@12178 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 91d9108 commit 26dc65481896d7bd1955afd29ea91f2b91892a19 @adrianholovaty adrianholovaty committed Jan 10, 2010
Showing with 12 additions and 2 deletions.
  1. +12 −2 docs/topics/templates.txt
View
@@ -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.

0 comments on commit 26dc654

Please sign in to comment.