Generalepydoc exclude wxpython

LaTeX specific issues not fitting into one of the other forums of this category.
Post Reply
Indira
Posts: 2
Joined: Tue Apr 08, 2008 11:03 am

epydoc exclude wxpython

Post by Indira »

I am using epydoc to document my wxPython (2.5)
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.

If anyone do know the solution please let me know !!

Cheers
Indira

Recommended reading 2024:

LaTeXguide.org • LaTeX-Cookbook.net • TikZ.org

Learn LaTeX easily with newest books:

The LaTeX Beginner's Guide: 2nd edition and perfect for students writing a thesis

The LaTeX Cookbook: 2nd edition full of practical examples for mathematics, physics, chemistry, and more

LaTeX Graphics with TikZ: the first book about TikZ for perfect drawings in your LaTeX thesis

Post Reply