Opened 8 years ago

Last modified 2 weeks ago

#27409 closed New feature

Django Admindocs links generation — at Initial Version

Reported by: Kris Avi Owned by: nobody
Component: contrib.admindocs Version: 1.10
Severity: Normal Keywords:
Cc: SAI GANESH S 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

Referring to:
https://docs.djangoproject.com/en/1.10/ref/contrib/admin/admindocs/

It seems the link generation isn't working as it should.

Let's say you want to generate link to tag "safe", then you have to use :tag:`built_in-safe` and it will generate link like "built_in-safe", whereas it may be better, if link text would be only the tag name or "safe". Same case with filters.

For views you can use generic class based views, in there by naming conventions can be capital letters. Class based views are classes and not methods and the naming of the view can be like BlogView or BlogEdit. But if generating link using the directives according to documentation it will not work since it will try to find view by name of "blogview" instead of "BlogView". It will automatically put it to lowercase and may make it not working.

Also after some experimenting, it seems like :view:`app_label.view_name` would not work, and have to use full path like: :view:`app_name.app_label.views.view_name`

Change History (0)

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