#344 epydoc fails to generate html


I'm trying to use epydoc to generate documentation for a python module. Unfortunately, epydoc chokes on the attached file. I'm using the following command to run epydoc: pydoc --html -o doc --debug -v virtualsmartcard. The command line output looks like this:

Failed to load symbol for: SCardCancelTransaction, /lib/libpcsclite.so.1: undefined symbol: SCardCancelTransaction! 00:04
| File /home/do/workspace/vsmartcard/virtualsmartcard/src/vpicc/virtualsmartcard/SEutils.py, line 184, in
| virtualsmartcard.SEutils.Security_Environment.manage_security_environment
| Warning: Line 197: Improper paragraph indentation.
Traceback (most recent call last): Progress: 00:00
File "/usr/bin/epydoc", line 13, in <module>===============================================================================----------------------------]
cli() Writing HTML docs to 'doc': virtualsmartcard.SmartcardSAM.SAM-class.html
File "/usr/lib/pymodules/python2.7/epydoc/cli.py", line 965, in cli
main(options, names)
File "/usr/lib/pymodules/python2.7/epydoc/cli.py", line 783, in main
write_html(docindex, options)
File "/usr/lib/pymodules/python2.7/epydoc/cli.py", line 823, in write_html
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 641, in write
self._write(self.write_class, directory, filename, doc)
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 711, in _write
write_func(f.write, *args)
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 909, in write_class
self.write_details_list(out, "Method Details", doc, "method")
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 2214, in write_details_list
self.write_details_entry(out, var_doc)
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 2219, in write_details_entry
descr = self.descr(var_doc, indent=2) or ''
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 3344, in descr
return self._attr_to_html('descr', api_doc, indent)
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 3338, in _attr_to_html
return self._attr_to_html(attr, api_doc.value, indent)
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 3336, in _attr_to_html
return self.docstring_to_html(pds, api_doc, indent)
File "/usr/lib/pymodules/python2.7/epydoc/docwriter/html.py", line 3361, in docstring_to_html
File "/usr/lib/pymodules/python2.7/epydoc/markup/epytext.py", line 1782, in to_html
docindex, context, indent)
File "/usr/lib/pymodules/python2.7/epydoc/markup/epytext.py", line 1820, in _to_html
for c in tree.children]
File "/usr/lib/pymodules/python2.7/epydoc/markup/epytext.py", line 1820, in _to_html
for c in tree.children]
File "/usr/lib/pymodules/python2.7/epydoc/markup/epytext.py", line 1885, in _to_html
raise ValueError('Unknown epytext DOM element %r' % tree.tag)
ValueError: Unknown epytext DOM element 'field'

Interestingly enough, generation of pdf documentation works like a charm

Best regards,


  • prz

    prz - 2011-11-11

    same problem here. Also with 'field'

  • prz

    prz - 2011-11-11

    That's how you cause it (field element like @note intended within a paragraph)

    """ Test it.
    @note: crash and burn

    @copyright: ::
    * text

  • prz

    prz - 2011-11-11

    once more preserving indentation, the indented @note is the death kneel

    ____Test it.
    ____@note: crash and burn

    __@copyright: ::
    _____* text


Log in to post a comment.