#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 , 9 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
follow-up: 3 comment:2 by , 9 years ago
comment:3 by , 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.
comment:4 by , 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 , 9 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:6 by , 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 , 9 years ago
Has patch: | set |
---|
comment:9 by , 9 years ago
Patch needs improvement: | set |
---|
comment:10 by , 9 years ago
Needs tests: | set |
---|---|
Patch needs improvement: | unset |
comment:11 by , 9 years ago
Needs tests: | unset |
---|
comment:12 by , 9 years ago
Patch needs improvement: | set |
---|
comment:13 by , 9 years ago
Patch needs improvement: | unset |
---|
comment:14 by , 9 years ago
Patch needs improvement: | set |
---|
comment:15 by , 9 years ago
Patch needs improvement: | unset |
---|
comment:16 by , 9 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
It would be appropriate to raise the issue on the DevelopersMailingList if you want to revisit this design decision.