On Mon, 9 Aug 2010 16:32:18 -0500
"Edward K. Ream" <[email protected]> wrote:

> On Mon, Aug 9, 2010 at 2:14 PM, Ville M. Vainio <[email protected]> wrote:
> 
> > Problem is documentation that wants to be "reference" before doing the
> > job of "tutorial".  
> 
> Great tip, particularly for the rst3 command.  I'll put in a tutorial
> section right after the overview.  This will show how I use @rst to
> create rST and sphinx sources.  That should ground people enough not
> to be blown away by the later reference stuff.

That's the pattern followed by the Django docs. 
http://docs.djangoproject.com/en/1.2/ which I think are really a candidate for 
a gold standard for software system docs.  In fact the tutorial links into the 
reference docs, so it continues to be a useful gateway, even after you've got 
the point of the tutorial.

Cheers -Terry

-- 
You received this message because you are subscribed to the Google Groups 
"leo-editor" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/leo-editor?hl=en.

Reply via email to