breathe/renderer/rst/doxygen/compound.py", line 284, in render ... KeyError: u'templateparam' about breathe HOT 8 CLOSED

Note same error with Sphinx 1.0.4 as well.

from breathe.

Without really knowing what I'm doing ;), I added a 'templateparam' entry to the lookup dict on line 272 of compound.py:

class DocParamListTypeSubRenderer(Renderer):

    lookup = {
            "param" : "Parameters",
            "exception" : "Exceptions",
            "templateparam" : "Templates"
            }

This got me by the initial error and it chugged along for awhile, then died with:

Exception occurred:
  File "/usr/lib/python2.6/dist-packages/_xmlplus/dom/expatbuilder.py", line 207, in parseFile
    parser.Parse(buffer, 0)
ExpatError: not well-formed (invalid token): line 211, column 82

I suspect this is a problem with my XML sources and nothing to do with breathe.

I'll leave it to you guys to close this if my fix is appropriate.

from breathe.

Err, oops. I closed it.

from breathe.

Hi,

Thank you for reporting it and for all the effort you've put into investigating it. I seem to spend my life making excuses on these tickets but I'm currently in the process of moving from UK to New Zealand, so I can't quite do this justice at the moment. I'm hoping that in a week or so I will have a proper go at it. Less if you feel this is a matter of urgency for you.

I love to hear of breathe being used and I'm sorry when it isn't as smooth as possible! Hopefully I'll will give it some much needed care and attention soon.

Michael

from breathe.

Hey Michael,

The fix I made works for me for now.

Good luck on your move across the world!

Josh

from breathe.

I'm getting an error much like this, but with "retval". In my local copy I've worked around it by replacing the line:

    name = self.lookup[self.data_object.kind]

with:

    name = self.lookup.get(self.data_object.kind, None)
    if not name:
        print "Warning: No name found for " + self.data_object.kind

I end up with an output header called "None" in the places where this happens, but at least it allows me to generate all the docs without halting due to an exception.

from breathe.

Thanks for reporting and the research into it. I'm embarrassed to say I didn't roll Josh's initial fix into the codebase. I simply forgot.

From the compound.xsd file it seems like the dict in question should need:

 lookup = {
        "param" : "Parameters",
        "exception" : "Exceptions",
        "templateparam" : "Templates",
        "retval" : "Return Value",
        }

So I'll commit that and hopefully we'll fine be from here on out!

Cheers,
Michael

from breathe.

Assuming the fix is enough. Will re-open if there are further issues.

from breathe.