Share

Python API documentation generation tool

Tracker: Bugs

5 Parser fails on class - ID: 1724434
Last Update: Comment added ( edloper )

Th efollowing page for LSR fails , but I cannot see any obvious reason

http://www.gnome.org/~parente/lsr/epydoc/Task.Tools.Base.TaskTools-class.ht
ml


Steve Lee ( stevelee ) - 2007-05-23 19:02

5

Closed

Works For Me

Edward Loper

source parsing

None

Public


Comments ( 2 )




Date: 2007-09-22 19:34
Sender: edloperProject Admin


Added a FAQ entry for this:

http://epydoc.sourceforge.net/faq.html#epytext_fail



Date: 2007-09-22 19:25
Sender: edloperProject Admin


Copying the docstring in question to a new file, and running epydoc on it,
gives us the following warning:

+------------------------------------------------------------------------------
| File /private/tmp/x/o.py, line 1, in o
| Warning: Line 40: Improper paragraph indentation.

Checking that line, we see it's:

@ivar def_out: Default output device to use for all
L{Task.Tools.Output.Output.say}
calls in this L{Perk} module.

The indent before "calls" is unexpected -- you need to either indent
L{Task.Tools.Output.Output.say} or dedent calls.

Epytext is a very "conservative" markup language. What I mean by that is
that if it sees anything that looks like it *might* not be epytext, it just
treats the docstring as plaintext instead. This makes it possible to run
epydoc on docstrings that were written without knowledge of epytext, which
eg contain ascii art, without getting gobledeygook as output.

If you find that a docstring is being rendered as plaintext, is almost
always means there's some epytext error in that docstring. Run epydoc on
that object, with -v, and check the warnings it generates.

-Edward



Log in to comment.

Attached File

No Files Currently Attached

Changes ( 4 )

Field Old Value Date By
status_id Open 2007-09-22 19:25 edloper
resolution_id None 2007-09-22 19:25 edloper
assigned_to nobody 2007-09-22 19:25 edloper
close_date - 2007-09-22 19:25 edloper