Re: [pygccxml-development] Updated status

[Roman Y. <rom...@gm...>]

On 3/8/06, Matthias Baas <ba...@ir...> wrote:
> Allen Bierbaum wrote:
> >> I've started creating a script generate_reference_manual.py in
> >> pygccxml/docs (based on Allen's generation script for the pyplusplus
> >> package). I haven't incorporated the stuff right into generate_docs.py
> >> because it also makes sense to run it in isolation but of course, it
> >> would be no problem to run that script from generate_docs.py as well.
> >> I already converted the doc strings in my directory_cache class to
> >> epytext markup and also modified a few doc strings at some other
> >> places in the pygccxml package (so far mainly to remove the
> >> warnings/errors). Roman, is it ok when I commit these things?
> >>
> > Does epydoc auto-link between related classes?
>
> It doesn't do that automatically (or is there an option to enable
> that?). Instead, you have to add explicit markup: L{class_t} or even
> L{class_t<declarations.class_t>} (see
> http://epydoc.sourceforge.net/epytext.html, section 3.3).
>
> > If so, shouldn't we
> > generate the reference documentation from both pygccxml and pyplusplus
> > at the same time so we can follow links from pygccxml types used in
> > pyplusplus?
>
> Well, Roman wants pygccxml to be independent from pyplusplus so I
> thought it makes sense to add the script to pygccxml/docs.
> If it proves to be useful the manual for pyplusplus could still include
> the manual for pygccxml so that there can be cross references. This only
> requires a few additional lines in the pyplusplus doc script and doesn't
> otherwise affect the doc strings in pygccxml.

Right, I plan to create setup file, that will install pygccxml and pypluspl=
us.
Also as a last screen it can give user an idea where to find the documentat=
ion.

Also pygccxml project is stand alone, I think you can add
documentation to it that is
related to pyplusplus, because it will give an user a hint how to use
this or that feature.

Don't you think so?

> - Matthias -

--
Roman Yakovenko
C++ Python language binding
http://www.language-binding.net/