Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#24917 closed New feature (fixed)

Allow admindocs to show more than just methods that can be called from templates

Reported by: Žan Anderle Owned by: Žan Anderle
Component: contrib.admindocs Version: dev
Severity: Normal Keywords: admindocs
Cc: 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

contrib.admindocs will only document template tags and functions that can be invoked from templates. Therefore it has limited use. It would be really useful to be able to document all of the functions. contrib.admindocs is a neat way of creating some basic documentation without any extra effort other than docstrings. By adding this feature, this potential could be fulfilled.

There could also be an option to highlight only the functions that can be invoked from templates, in order to support old functionality.

Change History (19)

comment:1 by Žan Anderle, 9 years ago

Owner: changed from nobody to Žan Anderle
Status: new → assigned

comment:2 by Tim Graham, 9 years ago

It would be appropriate to raise the issue on the DevelopersMailingList if you want to revisit this design decision.

in reply to:  2 comment:3 by Žan Anderle, 9 years ago

Replying to timgraham:

It would be appropriate to raise the issue on the DevelopersMailingList if you want to revisit this design decision.

​I just did. Let me know if there is anything else I can/should do.

Last edited 9 years ago by Tim Graham (previous) (diff)

comment:4 by Marc Tamlyn, 9 years ago

Accepting as I feel the "quick and dirty documentation tool for the whole dev team" is a more common paradigm than the "documentation tool for template authors only" one.

If however we do relax this, it opens up questions of what else should be included in the constructed docs? Forms? Views? URLs? Managers? Tasks?

At this point you're closer to a customised version of Sphinx's autodoc.

comment:5 by Marc Tamlyn, 9 years ago

Triage Stage: Unreviewed → Accepted

comment:6 by Tim Graham, 9 years ago

Summary: Extending contrib.admindocs functionality → Allow admindocs to show more than just methods that can be called from templates

comment:8 by Žan Anderle, 9 years ago

Has patch: set

comment:9 by Tim Graham, 9 years ago

Patch needs improvement: set

comment:10 by Žan Anderle, 9 years ago

Needs tests: set
Patch needs improvement: unset

comment:11 by Žan Anderle, 9 years ago

Needs tests: unset

comment:12 by Tim Graham, 9 years ago

Patch needs improvement: set

comment:13 by Žan Anderle, 9 years ago

Patch needs improvement: unset

comment:14 by Tim Graham, 9 years ago

Patch needs improvement: set

comment:15 by Žan Anderle, 9 years ago

Patch needs improvement: unset

comment:16 by Tim Graham, 9 years ago

Triage Stage: Accepted → Ready for checkin

comment:17 by Tim Graham <timograham@…>, 9 years ago

Resolution: → fixed
Status: assigned → closed

In f3dc173:

Fixed #24917 -- Made admindocs display model methods that take arguments.

comment:18 by Tim Graham <timograham@…>, 9 years ago

In 75143fa1:

Fixed #26182 -- Removed an obsolete (refs #24917) paragraph in admindocs.

comment:19 by Tim Graham <timograham@…>, 9 years ago

In c5d59173:

[1.9.x] Fixed #26182 -- Removed an obsolete (refs #24917) paragraph in admindocs.

Backport of 75143fa13f4f1ad2be84a103f7ce0eef9d06d3b4 from master

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