#18451 Improved class based view documentation #144

Closed
wants to merge 90 commits into
from
Commits on Jun 7, 2012
  1. Text wrapping.

    mjtamlyn committed Jun 7, 2012
  2. Changed references to 'simple generic class based views' to 'Fundamen…

    pydanny committed Jun 7, 2012
    …tal class based views'. Also worked on some new dialogue to help explain things
  3. Added much of what should hopefully be the new format for the View an…

    pydanny committed Jun 7, 2012
    …d TemplateView fundamental classes
  4. Best practices in list and detail views examples.

    mjtamlyn committed Jun 7, 2012
    Try to make the examples more consistent and follow some best practices.
    For example: all strings are single quoted, views are always defined via
    subclassing, and certain 1.4 now features are given for reference rather
    than re-implementing them.
  5. Finished documentation of fundamental views and also added working ex…

    pydanny committed Jun 7, 2012
    …ample code to all views
  6. Add new CBV & generic CBV topic documents into index.

    jaylett authored and James Aylett committed Jun 7, 2012
  7. Augment docstring to mention response_kwargs.

    jaylett authored and James Aylett committed Jun 7, 2012
  8. Update JSONResponseMixin to match newer TemplateResponseMixin, and pr…

    jaylett authored and James Aylett committed Jun 7, 2012
    …ovide a ref target for that section.
  9. Basic reference documentation of ContextMixin.

    jaylett authored and James Aylett committed Jun 7, 2012
  10. Stage one of CBV mixin topic docs: what's there and how it's used in …

    jaylett authored and James Aylett committed Jun 7, 2012
    …the generic views.
  11. Fix up reference to generic views documentation.

    jaylett authored and James Aylett committed Jun 7, 2012
  12. Merge pull request #1 from jaylett/cbv-docs

    pydanny committed Jun 7, 2012
    Cbv docs changes provided by @jaylett
  13. Temporary RST fix on a note

    pydanny committed Jun 7, 2012
  14. Initial content for cbv form handling page

    Simon Williams
    Simon Williams committed Jun 7, 2012
  15. Merge pull request #2 from SystemParadox/cbv-docs

    pydanny committed Jun 7, 2012
    Initial form handling CBV docs
  16. moved mention of the Base* views out of the generic CBV references an…

    pydanny committed Jun 7, 2012
    …d into a note section at the bottom
  17. Add some descriptions missing for core mixins.

    jaylett committed Jun 7, 2012
    Add "Methods & Attributes" headers throughout CBV mixin ref docs.
  18. Added views index

    pydanny committed Jun 7, 2012
  19. Merge pull request #3 from SystemParadox/cbv-docs

    pydanny committed Jun 7, 2012
    CBV form docs
  20. Changed CBV ref navigation to use a dedicated class-based-views direc…

    pydanny committed Jun 7, 2012
    …tory. This lets us break up the huge files into smaller, more digestible components
  21. Three examples of using mixins with other CBVs.

    jaylett committed Jun 7, 2012
    Both the more-complex-than-View + mixin examples are suspicious, and reinforce the view that this is a bad idea. I'd probably favour dropping the FormMixin + DetailView example as unreadable and unhelpful.
    
    The SingleObjectMixin + ListView requires a little thought, but is still just about manageable and is a helpful thing to be able to do. SingleObjectMixin + View is just fine.
Commits on Jun 8, 2012
  1. Added the mro.py prettification script at root of docs. Demonstrated …

    pydanny committed Jun 8, 2012
    …the results of the script by updating the MRO statements for fundamental, display, and edit class based views
  2. No more `"` and `'` mixing!

    mjtamlyn committed Jun 8, 2012
  3. Move class based view topic docs into their own subtree, matching

    James Aylett
    James Aylett committed Jun 8, 2012
    the ref docs.
  4. Merge remote branch 'pydanny/cbv-docs' into cbv-docs

    James Aylett
    James Aylett committed Jun 8, 2012
  5. Take the most vile example of combining generic CBV functionality

    James Aylett
    James Aylett committed Jun 8, 2012
    and present it as something not to do; explain a couple of other
    approaches of doing the same things which have fewer problems.
  6. Merge remote branch 'pydanny/cbv-docs' into cbv-docs

    James Aylett
    James Aylett committed Jun 8, 2012
  7. Update to new ref doc place for CBV mixins.

    James Aylett
    James Aylett committed Jun 8, 2012
  8. Merge pull request #6 from jaylett/cbv-docs

    pydanny committed Jun 8, 2012
    Mixins galore.
  9. Broke up the mixins reference in order to make it more human friendly…

    pydanny committed Jun 8, 2012
    …. The files went into the same directory as the CBV refs in order to keep nesting at a minimum.
  10. Link warning suitably.

    James Aylett
    James Aylett committed Jun 8, 2012
  11. More cross linking, and some more explanation, in generic editing

    James Aylett
    James Aylett committed Jun 8, 2012
    CBV topic.
  12. Merge pull request #7 from jaylett/cbv-docs

    pydanny committed Jun 8, 2012
    Cbv docs
  13. Corrected spelling issues, removed empty generic-date-based CBV topic…

    pydanny committed Jun 8, 2012
    … file, and other minor cleanups
  14. Moderate language regarding diy views.

    mjtamlyn committed Jun 8, 2012
    As requested by @pydanny.
  15. Merge pull request #5 from mjtamlyn/cbv-docs

    pydanny committed Jun 8, 2012
    First run through improving the generic cbv topic.
  16. Updates to the edit views' docstrings.

    kennethlove committed Jun 8, 2012
    Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
  17. Updates to the date views

    kennethlove committed Jun 8, 2012
    Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
  18. Updates to the base views

    kennethlove committed Jun 8, 2012
    Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
  19. Updates to the detail views

    kennethlove committed Jun 8, 2012
    Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
  20. Updates to the list views

    kennethlove committed Jun 8, 2012
    Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
  21. Fix some weird sentences.

    mjtamlyn committed Jun 8, 2012
Commits on Jun 9, 2012
  1. Merge pull request #8 from mjtamlyn/cbv-docs

    mjtamlyn committed Jun 9, 2012
    MOAR
  2. Tidy up topic pages.

    mjtamlyn committed Jun 9, 2012
    Remove broken refs, clarify a little text, fix and pep8 some code
    examples.
  3. Delete old files.

    mjtamlyn committed Jun 9, 2012
  4. Fix a grammatical error.

    mjtamlyn committed Jun 9, 2012
  5. Remove autodoc.

    mjtamlyn committed Jun 9, 2012
Commits on Jun 10, 2012
  1. RST tidyup.

    mjtamlyn committed Jun 10, 2012