To spare someone unknown some time:
A node titled
@rst-code somename
will look strange in the treepane of a future source file. But those titles 
will not get included as source-code into the resulting source files.
So if you want to produce documentation in rst and write code 
side-by-side(like me) and are to dumb to see the obvious (like me):

- Hold your breath,
- insert a clone of your method/class/whatever into your rst-tree,
- start the title with "@rst-code" (yes, will change in the code-tree BUT 
does nothing there)
- start rst3 in the top node of your rst-tree.
- enjoy your beautiful documentation. 

Man, am I stupid.

Greetings,

Holger Schuh

Am Dienstag, 11. Oktober 2011 17:57:59 UTC+2 schrieb wgw:
>
> I think I am using @rst in an awkward way, and would appreciate a few 
> pointers. 
>
> To document live code with rst2, I used subheading in the code like 
> <<subroutine>> and then cloned that node and put it into the rst doc 
> tree. 
>
> That doesn't work anymore: <<nodes>> are not recognized by rst3, so 
> I'm converting those clones to "@rst-no-head label". In the the live 
> code I have to replace <<subroutine>> with @others. That's awkward at 
> times. 
>
> All this requires a bit of fiddling. Am I missing the point of rst3? 
> There must be a better way... 
>
> Any suggestions? 
>
> Thanks! 
>

-- 
You received this message because you are subscribed to the Google Groups 
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.

Reply via email to