473,320 Members | 2,020 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,320 software developers and data experts.

Can Epydoc exclude wxPython?

tom
I would like to use Epydoc (3.0beta1) to document my wxPython (2.6.10)
application. The problem is that I can't seem to instruct Epydoc to not
also generate partial documentation of wxPython, which makes too much
verbiage for a user to wade through in order see the documentation of my
program.

For example, if my module consists of only the three lines

import wx
class BasicPanel(wx.Panel):
pass

the generated documentation for BasicPanel is completely swamped by the
over 100 instance methods and static methods for wx._core.Window, etc.

I've tried using the "exclude" command in a config file and command line
and also sprinkling around "@undocumented" commands in the .py file.
Neither of these make any difference as far as I can see, but they
aren't documented well in Epydocs so I'm not completely sure that I'm
using them correctly, although I've tried many, many variations all to
no avail. I've also tried turning off introspection and/or parsing, but
then the Epydoc output isn't as good.

Does anyone know of a way to avoid this? Short of fixing this in
Epydoc, how about a different documentation package -- I chose Epydoc
because it included clickable inheritance trees in the docs. Is there
another package that does this?

I installed Epydoc using epydoc-3.0beta1.win32.exe on Windows XP and am
using Python 2.4.3.

Thanks for any help,
Tom

P.S. - I haven't found any other group or mailing list that might be a
more focused forum for this question. Please let me know if you know of
one.
Mar 5 '07 #1
0 1412

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

1
by: Fuzzyman | last post by:
I've finally got round to using ResT and docutils. I had a little galnce at it about a year ago and for some reason concluded that ResTwas more of a pain than it was worth... very wrong. I've...
3
by: John Field | last post by:
Hello, Is it possible to exclude certain files in a wx.FileDialog, so that the user won't see them and can't select them with the mouse in de File open window? I was thinking of somehow...
0
by: simon | last post by:
Hi, We have a requirement for latex math (eg. $\sum_i x_i$) in our documentation, and i'm looking at patching epydoc to handle this. We have been using the python doc system (also used by...
0
by: Laszlo Zsolt Nagy | last post by:
Hello, I would like to create documentation for my lib using EpyDoc. I do not see how to report bugs on the EpyDoc home page. When I try to create documentation, I get this error: Internal...
2
by: Neil Benn | last post by:
Hello, I can;t find a epyDoc specific mailing list, so I'll try here - if you know of a epyDoc mailing list then please let me know (google is not my friend, I can only find an announce, devel...
2
by: programmer.py | last post by:
Hi everyone! I'm documenting some functions that return XML strings. I'd like to have `sample' xml show up in my epydoc generated documentation. However, epydoc does not like the indentation of...
2
by: Don Taylor | last post by:
Does anyone know what is needed to install to get epydoc to generate pdf files on Windows. Besides epydoc itself of course. Maybe there is a more appropriate forum to ask newbie questions about...
0
by: Edward Loper | last post by:
Epydoc 3.0 beta is now available for download from SourceForge. Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. - The epydoc homepage....
0
by: davels | last post by:
I'm trying to use epydoc (3.0beta1) to generate documentation for some packages I've installed as eggs. When I run the epydoc command "epydoc.py -v -o sqlalchemy sqlalchemy" in completes without...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
0
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.