add documentation on views, url, templates

Issue #1036 resolved
Tay Ray Chuan
created an issue

I've published this as [[http://bitbucket.org/rctay/satchmo/changeset/0a7b18f64f49/ | r1367 0a7b18f64f49]].

Here's the diffstat:

{{{ docs/Makefile | 50 ++++- docs/index.txt | 5 +- docs/payment.txt | 58 +++++- docs/templates.txt | 30 ++- docs/views.txt | 584 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 700 insertions(+), 27 deletions(-) }}}

A quick summary of the changes: docs/Makefile: setup a django/satchmo store for sphinx's autodoc to work docs/payment: some minor rewording and formatting * docs/payment: add documentation on paypal configuration (more API than user oriented)

And of course, the crown jewel: information on: urls and corresponding url names urls and corresponding views templates context variables * forms.

I've only done the common views for {{{product}}}, {{{satchmo_store}}} and {{{payment}}} (and only the {{{paypal}}} module at that).

Comments (5)

  1. Chris Moffitt repo owner

    This is excellent. I've been playing with it and it looks pretty good.

    When you get a chance, can you merge your fork with mine? Once you execute that merge, I think it will be a little easier for me to pull in your changes.

    Thanks again!

  2. Chris Moffitt repo owner

    Ok. I've merged in your changes to trunk. I made one minor change to the Makefile so it's a bit more portable.

    These changes are really good. Do you want me to close out this ticket or leave it open as you add new things.

  3. Log in to comment