Re: Looking for volunteers (was re: Revised Optik docs)

David Goodger <[email protected]> Thu, 27 May 2004 21:27:19 -0400
Newsgroups gmane.comp.python.optik.user
Message-ID <[email protected]>
Greg Ward wrote:
 > All right, haven't heard anything yet, so I assume the Optik docs
 > are now flawless and there is no further room for improvement.  ;-)

You're not the only one who's busy ;-)

 > So I'm going to start documenting the new features coming in 1.5.

Good idea to do that regardless.  Did you check the current doc files
into CVS?  I didn't see any checkin messages on optik-checkins (last
msg dated 2003-09-15).

 > It would be nice to get the improved docs into the Python manual,
 > though, in case there is a Python 2.3.4.

2.3.4 was released this morning.

 > Would anyone like to volunteer to convert the Optik reStructuredText
 > docs into LaTeX?

If we know which versions of the reST files correspond to the existing
LaTeX, we can take diffs & modify the LaTeX manually easily enough.

 > Preferably in a repeatable way?  (Ie. who wants to write a script
 > that will convert the Optik *.txt files into liboptparse.tex to drop
 > into Python's Doc/lib directory?)

Easier said than done :-)
But the doing may not be so hard... read on.

 > I noticed that docutils now includes a reST -> LaTeX
 > converter... who wants to play with it?

It's generic LaTeX, not the dialect spoken by Python's lib docs.  It
may be useful, but probably not directly.

There is some work on a direct reST -> DocPy ("Documenting Python"
dialect of LaTeX) in two Docutils sandboxes, Ed Loper's
(http://docutils.sf.net/sandbox/edloper/) and Dave Kuhlman's
(http://docutils.sf.net/sandbox/dkuhlman/).

-- 
David Goodger <http://python.net/~goodger>


-------------------------------------------------------
This SF.Net email is sponsored by: Oracle 10g
Get certified on the hottest thing ever to hit the market... Oracle 10g. 
Take an Oracle 10g class now, and we'll give you the exam FREE.
http://ads.osdn.com/?ad_id=3149&alloc_id=8166&op=click