epydoc-devel

[Epydoc-devel] module level variables (constants) missing

[Silverstein <he...@sc...>]

Using Epydoc version 2.1 on Linux the html that is generated does not
include the module-level variables.  For example, we want to include
some constants for people to use.  So we have something like the
following at the top of the module:

# Constants for select actions
ADD, REPLACE, INVERT, ALL, NONE = range(5)


I do not see a way to get these to show up in the documentation.  Is
there some way to do this?

If not, should I file an enhancement request?

Herc

Re: [Epydoc-devel] module level variables (constants) missing

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

On Jan 21, 2008 7:26 PM, Silverstein <he...@sc...> wrote:
> Using Epydoc version 2.1 on Linux the html that is generated does not
> include the module-level variables.  For example, we want to include
> some constants for people to use.  So we have something like the
> following at the top of the module:
>
> # Constants for select actions
> ADD, REPLACE, INVERT, ALL, NONE = range(5)

First, I'd recommend using epydoc 3.0 -- even though it's in beta, I
consider it more stable & robust than epydoc 2.1.  And it's got some
very nice new features.

Using epydoc 3.0, these variables should get documented *if* epydoc
can import the module in question.  If not (i.e., if it has to fall
back on source code parsing), then it won't be able to figure out the
values, so it won't document these variables.  But if they were listed
one-per-line, then source code parsing would be able to figure it out.

-Edward