Opened 5 years ago

Closed 5 years ago

Last modified 4 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: master
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 Changed 5 years ago by Žan Anderle

Owner: changed from nobody to Žan Anderle
Status: newassigned

comment:2 Changed 5 years ago by Tim Graham

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

comment:3 in reply to:  2 Changed 5 years ago by Žan Anderle

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 5 years ago by Tim Graham (previous) (diff)

comment:4 Changed 5 years ago by Marc Tamlyn

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 Changed 5 years ago by Marc Tamlyn

Triage Stage: UnreviewedAccepted

comment:6 Changed 5 years ago by Tim Graham

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

comment:7 Changed 5 years ago by Žan Anderle

comment:8 Changed 5 years ago by Žan Anderle

Has patch: set

comment:9 Changed 5 years ago by Tim Graham

Patch needs improvement: set

comment:10 Changed 5 years ago by Žan Anderle

Needs tests: set
Patch needs improvement: unset

comment:11 Changed 5 years ago by Žan Anderle

Needs tests: unset

comment:12 Changed 5 years ago by Tim Graham

Patch needs improvement: set

comment:13 Changed 5 years ago by Žan Anderle

Patch needs improvement: unset

comment:14 Changed 5 years ago by Tim Graham

Patch needs improvement: set

comment:15 Changed 5 years ago by Žan Anderle

Patch needs improvement: unset

comment:16 Changed 5 years ago by Tim Graham

Triage Stage: AcceptedReady for checkin

comment:17 Changed 5 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: assignedclosed

In f3dc173:

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

comment:18 Changed 4 years ago by Tim Graham <timograham@…>

In 75143fa1:

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

comment:19 Changed 4 years ago by Tim Graham <timograham@…>

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