[Django] #24917: Extending contrib.admindocs functionality

[Django]

#24917: Extending contrib.admindocs functionality
-----------------------------------+-----------------------
Reporter: zanderle | Owner: nobody
Type: New feature | Status: new
Component: contrib.admindocs | Version: master
Severity: Normal | Keywords: admindocs
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+-----------------------
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/24917>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Extending contrib.admindocs functionality
-----------------------------------+--------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+--------------------------------------
Changes (by zanderle):

* owner: nobody => zanderle
* needs_docs: => 0
* status: new => assigned
* needs_tests: => 0
* needs_better_patch: => 0


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Extending contrib.admindocs functionality
-----------------------------------+--------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+--------------------------------------

Comment (by timgraham):

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

--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Extending contrib.admindocs functionality
-----------------------------------+--------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+--------------------------------------

Post by Django
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:3>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Extending contrib.admindocs functionality
-----------------------------------+--------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+--------------------------------------

Comment (by mjtamlyn):

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.

--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:4>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Extending contrib.admindocs functionality
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by mjtamlyn):

* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------

--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:6>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------

Comment (by zanderle):

Just created a PR https://github.com/django/django/pull/4939

--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:7>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by zanderle):

* has_patch: 0 => 1


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:8>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by timgraham):

* needs_better_patch: 0 => 1


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:9>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by zanderle):

* needs_better_patch: 1 => 0
* needs_tests: 0 => 1


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:10>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by zanderle):

* needs_tests: 1 => 0


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:11>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by timgraham):

* needs_better_patch: 0 => 1


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:12>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by zanderle):

* needs_better_patch: 1 => 0


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:13>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#24917: Allow admindocs to show more than just methods that can be called from
templates
-----------------------------------+------------------------------------
Reporter: zanderle | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: admindocs | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------------+------------------------------------
Changes (by timgraham):

* needs_better_patch: 0 => 1


--
Ticket URL: <https://code.djangoproject.com/ticket/24917#comment:14>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.