add "squashed" index of CBV reference documentation
|Reported by:||ptone||Owned by:||nobody|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
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
Change History (5)
comment:1 Changed 5 years ago by ptone
- Has patch set
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset