Code

Opened 3 years ago

Closed 3 years ago

#16801 closed New feature (needsinfo)

Django-Admin could improve with docutils missing failures

Reported by: patricklemiuex@… Owned by: nobody
Component: Documentation Version: 1.3
Severity: Normal Keywords: documentation admin
Cc: Triage Stage: Someday/Maybe
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Especially in the context of beginners, I definitely wanted to have admin docs installed for my first django site, however, I didn't realize that docutils was a prerequisite, so I got an error about admin docs. I think instead, there should be an option to the user that showwsthat admin docs requires docutils and how to install it, or even a simple example of that in settings as comment at least.

Attachments (0)

Change History (1)

comment:1 Changed 3 years ago by anonymous

  • Component changed from Uncategorized to Documentation
  • Keywords documentation admin added
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to needsinfo
  • Status changed from new to closed
  • Triage Stage changed from Unreviewed to Someday/Maybe
  • Type changed from Uncategorized to New feature

The documentation about this is here: https://docs.djangoproject.com/en/dev/ref/contrib/admin/admindocs/

Would you want a link to this documentation from the settings.py? There are other requirements for each thing you enable in django. I'm not sure that adding more comments in the settings.py is the right way to go.

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.