Re: [Epydoc-devel] --exclude pattern problem

[Edward L. <ed...@se...>]

On Sat, Mar 29, 2008 at 3:00 PM, oti...@ya...
<oti...@ya...> wrote:
>  In one of the modules I'm trying to generate the API for, a pretty big
>  external module is imported (numpy). [...]

The problem that trips up epydoc is the combination of these two lines:

>   import numpy as N
>   __all__ = ['bar','N']

>From the __all__ line, epydoc assumes that "foo.N" is part of foo, and
so it decides it needs to document the value of N.  Of course, the
value of N is the numpy module, so this goes off and documents numpy.

I just committed a patch to svn (revision 1810), which modifies the
docintrospector to treat all module-valued variables as imported, even
if they appear in __all__.  This will fix the problem of having numpy
get documented when it shouldn't.  But the generated documentation
won't include any docs for the "N" variable.  (It's not clear to me
what the documentation for that variable should be if it were
included, though, so hopefully that's not a problem.)

If you get a chance to check out the svn revision, please let me know
whether this solves your problem.  For instructions for using svn, see
the eypdoc webpage (http://epydoc.sf.net/).

Thanks,
-Edward