Paul, On 03/03/2011 17:39, Paul McNett wrote: > On 3/3/11 8:08 AM, Werner F. Bruhin wrote: >> What should be the approach to get "DockSide" into the documentation? >> >> As _dDockPanel is private DockSide and others are not showing up in the >> documentation. >> >> Any ideas on how they could be included without including/showing >> _dDockPanel itself? >> >> Are there other things like this we need to consider when generating the >> documentation? > I guess I misunderstood prior posts: I thought you had a way to generate > public > subclasses when a superclass was private, and I said I'd prefer to not > clutter the > docs with the method signatures of the private superclass. > I believe this is solved in the current Sphinx docs, i.e. if class "a" inherits from "_b" then methods "a" inherits from "_b" are shown in a but no link to "_b" is provided. > But if it's a question of either not showing the docs for a public class, or > cluttering the documentation with private class docs, I'd vote for including > the > private stuff at least for now. _dDockPanel is not inherited by anyone, just used internally by dDockForm, that is why its methods don't show up anywhere in the doc.
Maybe I add another list to check and add classes like _dDockPanel to it, then generate documentation for these but do not show them on pages like http://thewinecellarbook.com/daboDocTestAlt/dabo.ui_module.html but when one searches for e.g. DockSide one will find the page. Probably need to add a doc string to _dDockPanel to explain some of this, i.e. only here for its methods or something along those lines. Werner _______________________________________________ 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]
