Opened 15 years ago

Closed 15 years ago

#11884 closed (fixed)

Clarify in documentation how to enable built-in reference in admin.

Reported by: DmitryRisenberg Owned by: nobody
Component: Documentation Version: 1.1
Severity: Keywords: admin reference setup
Cc: commando@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Setting up ​built-in reference in admin is not described anywhere in the docs - it requires adding django.contrib.admindocs.urls to INSTALLED_APPS, adding (r'^admin/doc/', include('django.contrib.admindocs.urls')) to urlpatterns and installing docutils if they are not present. Finding this out for me was untrivial and required googling, so I would add description of these steps to the corresponding section of documentation (see the patch).

Attachments (2)

templates_doc.diff​ (1.1 KB ) - added by DmitryRisenberg 15 years ago.
Patch to documentation
11884.diff​ (1.2 KB ) - added by Tim Graham 15 years ago.
few minor corrections to existing patch

Download all attachments as: .zip

Change History (5)

by DmitryRisenberg, 15 years ago

Attachment: templates_doc.diff​ added

Patch to documentation

by Tim Graham, 15 years ago

Attachment: 11884.diff​ added

few minor corrections to existing patch

comment:1 by Tim Graham, 15 years ago

Triage Stage: Unreviewed → Ready for checkin

comment:2 by DmitryRisenberg, 15 years ago

Cc: commando@… added

comment:3 by Adrian Holovaty, 15 years ago

Resolution: → fixed
Status: new → closed

(In [12178]) Fixed #11884 -- Clarified documentation to explain how to activate the built-in admin reference. Thanks, DmitryRisenberg and timo

Note: See TracTickets for help on using tickets.
Back to Top