Am 2010-10-14 um 16:24 schrieb Paul McNett: > On 10/14/10 2:52 AM, Henning Hraban Ramm wrote: >> Is there a reason that some classes aren't in the API docs (e.g. >> dPref)? >> Can you change it to include all dabo classes? > > They are quto-generated and include all dabo classes it can find. > Here's the reason > why dPref isn't found: > > class dPref(object): > ... > > If a class doesn't ultimately inherit from dObject, it won't have > properties, events, > and methods in an expected convention from which to auto-generate > the docs. > > If I changed it to auto-generate every class found, I think there'd > be a lot of noise > in the api docs. > > I'm open to suggestions...
I don't know how other documentation systems (pydoctor, pydoc, Sphinx, Doxygen, Apydia, ...) do it. (I also didn't look how you generate docs.) Can't you just use one of those? (Perhaps additionally?) I just tried Sphinx on dabo - it's easy and looks good, but requires you at least to list all modules, that you want documented, in ReST files. If I'll ever complete my current projects, I can provide a setup for that, if you like. Greetlings from Lake Constance! Hraban --- http://www.fiee.net https://www.cacert.org (I'm an assurer) _______________________________________________ Post Messages to: [email protected] Subscription Maintenance: http://leafe.com/mailman/listinfo/dabo-users Searchable Archives: http://leafe.com/archives/search/dabo-users This message: http://leafe.com/archives/byMID/[email protected]
