#17378: add "squashed" index of CBV reference documentation
-------------------------------+--------------------
Reporter: ptone | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.3
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
The current CBV reference documentation is organized by mixin, then by
view classes documenting attributes and methods where they are defined.
This is a valid approach for documenting the collection of mixins as a
"toolkit" for building your own class-based views, but is problematic to
use as someone just using the resulting generic class-based views.
Understanding just the use of the generic views requires jumping all
around the reference documentation by looking at what mixins are used.
Originally I looked into duplicating the reference documentation under two
different organizations by updating docstrings and using inspect.getdoc -
however the Django documentation is usually more than what is in a
docstring, and I didn't want to inject too much doc building machinery.
So the compromise was to use a script to traverse the class MRO for each
view and generate an alternative index, linking to the current
documentation.
this is related to 16807
--
Ticket URL: <https://code.djangoproject.com/ticket/17378>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
