[Jython-users] Re: [Jython-dev] Generating jython documentation

[<Jen...@i2...>]

Thanks for your reply, Samuele.  I guess I'll follow up with HappyDoc, 
then.

Jennifer





"Samuele Pedroni" <ped...@bl...>
01/14/02 06:26 PM
Please respond to "Samuele Pedroni"

 
        To:     <Jen...@i2...>, <jyt...@so...>
        cc: 
        Subject:        Re: [Jython-dev] Generating jython documentation


Hi.

> Nobody replied to my question in jython-users, so I thought I'd try over
> here.
>
> Is there any way to generate documentation from doc strings in jython? I

Not one directly supported by jython core devlopers.

> need to be able to generate documentation, javadoc-style, for a jython
> library I'm putting together.  If there is no way to do this, are there
> plans for it to be added to jython?

AFAIK there is no plan for such a service coming
directly with the distribution.

>
> I found something called HappyDoc which I might be able to use, but
> unfortunately, I think I'd have to run it on my Jython py files using
> CPython,

Yup, it is CPython parser module based. And the original parser
module for CPython is not supported in Jython. We have
different parser under the hood. In theory
HappyDoc should do your job.

Ideally this kind of tools should move to use the parsing/analysis tools
in the new Jeremy Hylton's compiler tool. That is also GvR
reccomandation. (Btw I plan to make that work with Jython parser,
when I can )
But e.g PyChecker still analyses the python bytecode, and
 HappyDoc uses the old parser module.
and obviously CPython tool developers use their resources
as they wish/can afford.

>and also I think it has a bug right now which prevents it from
> working on Windows.  Not the ideal solution.

That you should discuss with their developer, I have so far
never tried it myself.

regards, Samuele Pedroni.