id	summary	reporter	owner	description	type	status	component	version	severity	resolution	keywords	cc	stage	has_patch	needs_docs	needs_tests	needs_better_patch	easy	ui_ux
17378	"add ""squashed"" index of CBV reference documentation"	Preston Holmes	nobody	"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"	New feature	closed	Documentation	1.3	Normal	fixed			Accepted	1	0	0	0	0	0