Code

Opened 5 years ago

Closed 4 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: UI/UX:

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 5 years ago.
Patch to documentation
11884.diff (1.2 KB) - added by timo 4 years ago.
few minor corrections to existing patch

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by DmitryRisenberg

Patch to documentation

Changed 4 years ago by timo

few minor corrections to existing patch

comment:1 Changed 4 years ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Ready for checkin

comment:2 Changed 4 years ago by DmitryRisenberg

  • Cc commando@… added

comment:3 Changed 4 years ago by adrian

  • Resolution set to fixed
  • Status changed from new to closed

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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.