[RFC] improve documentation on templates

1 view
Skip to first unread message

rctay

unread,
Feb 23, 2010, 10:58:05 AM2/23/10
to Satchmo developers
Perhaps we can add a table to map template files to views and urls?

I've something cooking here:

http://bitbucket.org/rctay/satchmo/changeset/46ec7b24fcb4/

This may be useful for designers who want to know which template is
pointed to by which url.

I made a separate view section so that I didn't have to put the
template path into the table - file paths caused problems with RST.
But it could also act to document the views used by Satchmo and help
hackers.

(I used autodoc for methods that had it; for building with sphinx to
work, some Makefile tweaking would be needed.)

Chris Moffitt

unread,
Feb 23, 2010, 12:49:24 PM2/23/10
to satchmo-d...@googlegroups.com
I like this. I think it would be really useful for folks.

What do you need from us to help?

-Chris


--
You received this message because you are subscribed to the Google Groups "Satchmo developers" group.
To post to this group, send email to satchmo-d...@googlegroups.com.
To unsubscribe from this group, send email to satchmo-develop...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/satchmo-developers?hl=en.


Tay Ray Chuan

unread,
Feb 23, 2010, 7:43:54 PM2/23/10
to satchmo-d...@googlegroups.com
Hi,

On Wed, Feb 24, 2010 at 1:49 AM, Chris Moffitt <ch...@moffitts.net> wrote:
> I like this. I think it would be really useful for folks.
>
> What do you need from us to help?

heh, just needed the go-ahead. :)

I'll get comments from here when I've something substantial.

--
Cheers,
Ray Chuan

FranckB

unread,
Mar 16, 2010, 9:42:47 AM3/16/10
to Satchmo developers
Hi ray
Any advance on that ?
The previous bitbucket link is broken ?

Tay Ray Chuan

unread,
Mar 16, 2010, 7:40:09 PM3/16/10
to satchmo-d...@googlegroups.com
Hi,

On Tue, Mar 16, 2010 at 9:42 PM, FranckB <franc...@gmail.com> wrote:
> Hi ray
> Any advance on that ?

yes, some of my attempt at documenting views have been integrated upstream.

See this ticket for details:

http://bitbucket.org/chris1610/satchmo/issue/1036/add-documentation-on-views-url-templates

It's not complete though - the template-through-view approach still
leaves out some templates.

> The previous bitbucket link is broken ?

So it seems; but it's immaterial, since it's already in satchmo.

--
Cheers,
Ray Chuan

Reply all
Reply to author
Forward
0 new messages