From: Fernando G. <fj...@gm...> - 2009-12-29 18:12:18
|
Hi, I wonder if anyone here has ideas or suggestions about writing literate programs [1] with noweb [2], using reStructuredText as the language for the documentation chunks. That is, how to feed noweave with a source file that uses reStructuredText, and obtain as output a valid reStructuredText document. If the above paragraph sounds too cryptic, I'll gladly provide more details -- but perhaps I'm too lucky and someone already understood what I'm looking for :-) [1] http://en.wikipedia.org/wiki/Literate_programming [2] http://www.cs.tufts.edu/~nr/noweb/ -- Fernando Gómez Biblioteca "Antonio Monteiro" INMABB (Conicet / Universidad Nacional del Sur) Av. Alem 1253 B8000CPB Bahía Blanca, Argentina Tel. +54 (291) 459 5116 http://inmabb.criba.edu.ar/ |
From: Gour <go...@go...> - 2009-12-29 20:10:27
Attachments:
signature.asc
|
On Tue, 29 Dec 2009 15:11:51 -0300 >>>>>> "Fernando" == Fernando Gómez <fj...@gm...> wrote: Fernando> If the above paragraph sounds too cryptic, I'll gladly Fernando> provide more details -- but perhaps I'm too lucky and someone Fernando> already understood what I'm looking for :-) I'd say that Leo might be the right choice. Take a look at: http://webpages.charter.net/edreamleo/front.html Sincerely, Gour -- Gour | Hlapicina, Croatia | GPG key: F96FF5F6 ---------------------------------------------------------------- |
From: weakish j. <we...@gm...> - 2009-12-30 01:57:12
|
I have not used noweb. I'm using Pylit__ (semi-literate but sufficient) happily. __ http://pylit.berlios.de |
From: Fernando G. <fj...@gm...> - 2009-12-29 22:07:02
|
2009/12/29 Gour <go...@go...>: > I'd say that Leo might be the right choice. Take a look at: > > http://webpages.charter.net/edreamleo/front.html Thanks Gour for your suggestion. In fact, I had already considered Leo some months ago, when I was choosing tools for literate programming (LP). The reason I did not choose Leo was that I wanted to keep things simple. Leo looks like a powerful tool, but it seems to require that you learn a special way of working; besides, I have some reluctance to tie a software project to a particular editor... But nothing of what I'm saying is against Leo, of course. My decision was: edit source files with Gedit (applying appropriate syntax highlighting), and use notangle/noweave to obtain the desired output. For the particular project I'm working on, it's been a good decision, except for the issue that motivated me to ask for help. In order to use reST for writing documentation (in my gedit + noweb approach to LP), I wrote a Python script that converts the source files into pure reST, converts them to html through rst2html, then converts that html into an acceptable noweb source file, and finally calls noweave to obtain the html version of the docs. The problem with this approach is that the reST version of the document is lost in the way; I'd like to obtain reST as output, so that tools like Sphinx can be applied to the documentation. But noweb only generates (natively) HTML or LaTeX. As explained in the Noweb Hacker's Guide [1], one could write a "backend" for noweb that outputs reST, and that could solve my problem. So what I was asking can be stated like this: do you know of a backend for noweb that outputs reST? [1] http://www.cs.tufts.edu/~nr/noweb/guide.ps -- Fernando Gómez Biblioteca "Antonio Monteiro" INMABB (Conicet / Universidad Nacional del Sur) Av. Alem 1253 B8000CPB Bahía Blanca, Argentina Tel. +54 (291) 459 5116 http://inmabb.criba.edu.ar/ |
From: Gour <go...@go...> - 2009-12-30 08:54:39
Attachments:
signature.asc
|
On Tue, 29 Dec 2009 19:06:29 -0300 >>>>>> "Fernando" == Fernando Gómez <fj...@gm...> wrote: Fernando> In fact, I had already considered Leo some months ago, when I Fernando> was choosing tools for literate programming (LP). The reason Fernando> I did not choose Leo was that I wanted to keep things simple. Leo is quite simple. Fernando> Leo looks like a powerful tool, but it seems to require that Fernando> you learn a special way of working; besides, I have some Fernando> reluctance to tie a software project to a particular Fernando> editor... But nothing of what I'm saying is against Leo, of Fernando> course. You can use as much as you want from Leo - it can be used as pure outliner to help you organize your project. I've never used noweb for LP,. but Leo's auto/rst/shadow...nodes looks quite simple & powerful. I plan to use Leo for my Python/Django development, for Haskell projects as well as for all my writing involving authoring in rst and producing e.g. html output with Sphinx. Moreover, you can use Leo with other editors - I use it with Emacs, so you're not tied to specific editor, although I do not know if gedit is supported. It's best to try in Leo's mailing list and pull the latest code from bzr repo. ;) Sincerely, Gour p.s. I'm CC-ing since gmane authorization is not enough for posting. -- Gour | Hlapicina, Croatia | GPG key: F96FF5F6 ---------------------------------------------------------------- |