epydoc and twisted/django

View: New views
5 Messages — Rating Filter:   Alert me  

epydoc and twisted/django

by lists-144 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi,

when Epydoc tries to generate the docs [1] with Python 2.4 it shows  
these errors:

Writing PyAMF API Documentation to /var/www/pyamf.org/api
Warning: Module django.http is shadowed by a variable with the same  
name.
Warning: Module twisted.internet.defer is shadowed by a variable with  
the same name.
Warning: Module twisted.internet.protocol is shadowed by a variable  
with the same name.
Warning: Module twisted.internet.threads is shadowed by a variable  
with the same name.

This also causes it to print the Twisted doc info [2].

Any idea what we can do about this (with epydoc)?

Cheers,

Thijs

[1] http://api.pyamf.org
[2] http://api.pyamf.org/pyamf.gateway.twisted-module.html


Re: epydoc and twisted/django

by Nick Joyce :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Having not used Epydoc before, I'm kinda shooting in the dark. I'm not sure there is not much I can do about the warnings, the import hack is pretty ugly so we can either rename the gateway modules or live with the warnings (assuming that they are only printed to stderr?). I couldn't see any obvious problems with [2].

I have removed some of the crud so that the import var hacks don't hang around, r408.

On Tue, 2007-11-27 at 17:08 +0100, Thijs Triemstra | Collab wrote:
Hi,

when Epydoc tries to generate the docs [1] with Python 2.4 it shows  
these errors:

Writing PyAMF API Documentation to /var/www/pyamf.org/api
Warning: Module django.http is shadowed by a variable with the same  
name.
Warning: Module twisted.internet.defer is shadowed by a variable with  
the same name.
Warning: Module twisted.internet.protocol is shadowed by a variable  
with the same name.
Warning: Module twisted.internet.threads is shadowed by a variable  
with the same name.

This also causes it to print the Twisted doc info [2].

Any idea what we can do about this (with epydoc)?

Cheers,

Thijs

[1] http://api.pyamf.org
[2] http://api.pyamf.org/pyamf.gateway.twisted-module.html
_______________________________________________
PyAMF dev mailing list - dev@...
http://lists.pyamf.org/mailman/listinfo/dev
Nick
--

Nick Joyce

Box Design
www.boxdesign.co.uk

T: +44 (0)117 9044 850
M: +44 (0)7999 822 502

Re: epydoc and twisted/django

by Arnar Birgisson :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Yes, this is probably due to the import hack. Maybe look for how other
people solved the naming issue?

Arnar

On Nov 27, 2007 4:32 PM, Nick Joyce <nick@...> wrote:

>
>  Having not used Epydoc before, I'm kinda shooting in the dark. I'm not sure
> there is not much I can do about the warnings, the import hack is pretty
> ugly so we can either rename the gateway modules or live with the warnings
> (assuming that they are only printed to stderr?). I couldn't see any obvious
> problems with [2].
>
>  I have removed some of the crud so that the import var hacks don't hang
> around, r408.
>
>
>
>  On Tue, 2007-11-27 at 17:08 +0100, Thijs Triemstra | Collab wrote:
>  Hi,
>
> when Epydoc tries to generate the docs [1] with Python 2.4 it shows
> these errors:
>
> Writing PyAMF API Documentation to /var/www/pyamf.org/api
> Warning: Module django.http is shadowed by a variable with the same
> name.
> Warning: Module twisted.internet.defer is shadowed by a variable with
> the same name.
> Warning: Module twisted.internet.protocol is shadowed by a variable
> with the same name.
> Warning: Module twisted.internet.threads is shadowed by a variable
> with the same name.
>
> This also causes it to print the Twisted doc info [2].
>
> Any idea what we can do about this (with epydoc)?
>
> Cheers,
>
> Thijs
>
> [1] http://api.pyamf.org
> [2] http://api.pyamf.org/pyamf.gateway.twisted-module.html
> _______________________________________________
> PyAMF dev mailing list - dev@...
> http://lists.pyamf.org/mailman/listinfo/dev
>
>
>  Nick
>  --
>
>  Nick Joyce
>
>  Box Design
>  www.boxdesign.co.uk
>
>  T: +44 (0)117 9044 850
>  M: +44 (0)7999 822 502
> _______________________________________________
> PyAMF dev mailing list - dev@...
> http://lists.pyamf.org/mailman/listinfo/dev
>
>


Re: epydoc and twisted/django

by lists-144 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Allright. It looks like it's a Python 2.4 thing, because I'm not getting those errors with 2.5. I also tried upgrading to the latest trunk version of epydoc but still the same errors. Let's not bother about it, as long as the import var hacks work.

I removed some Twisted debug stuff in r406 but see you added it back in r407/408. Was this on purpose or ?

thanks,

Thijs


On Nov 27, 2007, at 5:32 PM, Nick Joyce wrote:

Having not used Epydoc before, I'm kinda shooting in the dark. I'm not sure there is not much I can do about the warnings, the import hack is pretty ugly so we can either rename the gateway modules or live with the warnings (assuming that they are only printed to stderr?). I couldn't see any obvious problems with [2].

I have removed some of the crud so that the import var hacks don't hang around, r408.

On Tue, 2007-11-27 at 17:08 +0100, Thijs Triemstra | Collab wrote:
Hi,

when Epydoc tries to generate the docs [1] with Python 2.4 it shows  
these errors:

Writing PyAMF API Documentation to /var/www/pyamf.org/api
Warning: Module django.http is shadowed by a variable with the same  
name.
Warning: Module twisted.internet.defer is shadowed by a variable with  
the same name.
Warning: Module twisted.internet.protocol is shadowed by a variable  
with the same name.
Warning: Module twisted.internet.threads is shadowed by a variable  
with the same name.

This also causes it to print the Twisted doc info [2].

Any idea what we can do about this (with epydoc)?

Cheers,

Thijs

[1] http://api.pyamf.org
[2] http://api.pyamf.org/pyamf.gateway.twisted-module.html
_______________________________________________
PyAMF dev mailing list - dev@...
http://lists.pyamf.org/mailman/listinfo/dev
Nick
--

Nick Joyce

Box Design
www.boxdesign.co.uk

T: +44 (0)117 9044 850
M: +44 (0)7999 822 502
_______________________________________________
PyAMF dev mailing list - dev@...


Re: epydoc and twisted/django

by Nick Joyce :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Humm,

I wonder why svn didn't show that up. Reverted in r410

On Tue, 2007-11-27 at 17:37 +0100, Thijs Triemstra | Collab wrote:
Allright. It looks like it's a Python 2.4 thing, because I'm not getting those errors with 2.5. I also tried upgrading to the latest trunk version of epydoc but still the same errors. Let's not bother about it, as long as the import var hacks work.


I removed some Twisted debug stuff in r406 but see you added it back in r407/408. Was this on purpose or ?


thanks,


Thijs



On Nov 27, 2007, at 5:32 PM, Nick Joyce wrote:

Having not used Epydoc before, I'm kinda shooting in the dark. I'm not sure there is not much I can do about the warnings, the import hack is pretty ugly so we can either rename the gateway modules or live with the warnings (assuming that they are only printed to stderr?). I couldn't see any obvious problems with [2].

I have removed some of the crud so that the import var hacks don't hang around, r408.

On Tue, 2007-11-27 at 17:08 +0100, Thijs Triemstra | Collab wrote:
Hi,

when Epydoc tries to generate the docs [1] with Python 2.4 it shows  
these errors:

Writing PyAMF API Documentation to /var/www/pyamf.org/api
Warning: Module django.http is shadowed by a variable with the same  
name.
Warning: Module twisted.internet.defer is shadowed by a variable with  
the same name.
Warning: Module twisted.internet.protocol is shadowed by a variable  
with the same name.
Warning: Module twisted.internet.threads is shadowed by a variable  
with the same name.

This also causes it to print the Twisted doc info [2].

Any idea what we can do about this (with epydoc)?

Cheers,

Thijs

[1] http://api.pyamf.org
[2] http://api.pyamf.org/pyamf.gateway.twisted-module.html
_______________________________________________
PyAMF dev mailing list - dev@...
http://lists.pyamf.org/mailman/listinfo/dev
Nick
--

Nick Joyce

Box Design
www.boxdesign.co.uk

T: +44 (0)117 9044 850
M: +44 (0)7999 822 502
_______________________________________________
PyAMF dev mailing list - dev@...
http://lists.pyamf.org/mailman/listinfo/dev


_______________________________________________
PyAMF dev mailing list - dev@...
http://lists.pyamf.org/mailman/listinfo/dev
Nick
--

Nick Joyce

Box Design
www.boxdesign.co.uk

T: +44 (0)117 9044 850
M: +44 (0)7999 822 502