ANN: Leo 4.1 final

Edward K. Ream edreamleo at charter.net
Fri Feb 20 15:58:42 EST 2004


> I am actually trying to set up a Leo-based documentation project right
> now (though I am pretty new to it). Are there any previous case-studies
> on people doing documentation?

The new rst2.py plugin might be a real good place to start.  See the
documentation in the node called "Description of rst2 by Steve Zatz"

The short form:

"""If a headline starts with @rst <filename>, double-clicking on it will
write a file in outline order, with the headlines converted to
reStructuredText
section headings.

If the name of the <filename> has the extension .html, .htm or .tex, and if
you have
docutils installed, it will generate HTML or LaTeX, respectively."""

> In particular I am interested in being
> able to embed Leo node links directly in another node's text (for
> automatic HTML generation). I know I can do it through programming (or
> XSLT...brrrr....), but I am really trying avoid re-inventing the wheel
> due to the project's time constraints. Any info would help.

I suspect that you can do almost anything you want with rst2.py.  I'll be
posting Steve's own examples on Leo's web site today:

- wxListManager.leo:  the "source code" for the documentation.
- listManagerDocs.html:  the html output created by rst2.py plugin.
- several stylesheets for use by generated files.

When you see listManagerDocs.html I think you will be impressed with the
kinds of things that can be done with Leo+rst+docutils+(optional)silver
city+web standards.

Thanks for this question.  Steve's work deserves much more attention than it
has gotten so far.

Edward
--------------------------------------------------------------------
Edward K. Ream   email:  edreamleo at charter.net
Leo: Literate Editor with Outlines
Leo: http://webpages.charter.net/edreamleo/front.html
--------------------------------------------------------------------





More information about the Python-list mailing list