Opened 13 years ago
Closed 12 years ago
#17378 closed New feature (fixed)
add "squashed" index of CBV reference documentation
Reported by: | Preston Holmes | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 1.3 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
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
Attachments (1)
Change History (5)
comment:1 by , 13 years ago
Has patch: | set |
---|
comment:2 by , 13 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:3 by , 12 years ago
I have written something like this at http://ccbv.co.uk/ and would really like to get involved with getting something like this into the official docs.
by , 12 years ago
Attachment: | 17378.diff added |
---|
Fixed a couple typos in Preston's original pull request and updated formatting
comment:4 by , 12 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
https://github.com/django/django/pull/89