[Doc-SIG] Python docs in reST?

Skip Montanaro skip at pobox.com
Wed May 18 19:36:53 CEST 2005


    >> * dump latex2html

    Michael> It works most of the time these days!

I was under the impression that Fred was still dealing with a forked version
of the code and that it was still fairly fragile.

    >> * better potential HTML generation options (like HTML w/ an integrated
    >> annotation capability)

    Michael> But only, very much "potential".

Sure, but how much experimentation do you think is practical using
latex2html?

    >> * possibly enlarge pool of documentation contributors

    Michael> Yeah, right.  This is where my lack of faith in humanity comes
    Michael> out.

Understood.

    Michael> I believe there has been a long-ish term standing offer from
    Michael> assorted people to turn plain text docs into suitable latex for
    Michael> the docs (if not, let me make one).

A number of people (myself included) have made this offer on multiple
occsions, generally in response to some variant of "Python's documentation
sucks".  (Which we all know it doesn't, but they complain just the same.)

    Michael> The main reason that Python's documentation is patchy in places
    Michael> is because writing good content is hard!  Dealing with *any*
    Michael> format is minor in comparison.

I would be happy if people contributed examples or submitted enhancement
requests that referred to cookbook recipes.

    >> Fred wrote some Latex->ESIS->SGML tools that look like they might
    >> possibly be redirected to the more-or-less one-time task of
    >> converting to reST.

    Michael> I don't know if the task of generating reST has been really
    Michael> solved, either.

Yeah, that seems to be a stumbling block.

Skip


More information about the Doc-SIG mailing list