On Monday, January 31, 2011 08:25:54 am Werner F. Bruhin wrote: > On 31/01/2011 06:04, Paul McNett wrote: > > On 1/30/11 2:24 AM, Werner F. Bruhin wrote: > >> I made some progress on it but before investing more time in this I > >> would like to find out this would be of interest - or if I step on some > >> ones foot:-) . > > > > I encourage you to do it! Several years ago when I first wrote the > > autodoc generator the api doc generators at the time resulted in too > > much noise and not enough signal, which is why I rolled my own. It > > satisfied the need, and I always thought I would keep expanding it and > > making it nicer, searchable, etc. > > > > If your Sphinx configuration gets us further down the path, then let's > > use it, by all means! > > I thought it might be good for everyone to see what is there today and > to provide comments on all this, I therefore uploaded what I have > currently to one of my own sites so people can look at it and comment. > > What is there: > - an Home page, still some stuff from AGW as place holders > - currently only a sub-set of Dabo is there (things directly below Dabo, > e.g. dApp etc, "biz", "db" and part of "lib" > - Gallery only has one sample > > following needs still to be done: > - home page clean up, was thinking of basically using the content from > http://dabodev.com/ and it would be nice to have some nice Dabo > Application screen shots to replace the "AUI" place holder. > - include all of Dabo's sub packages > - remove Inheritance diagrams where they don't make sense > - create Gallery entries for all widgets > - clean up, better structure for the Master Index page (contents) > - clean up the "Module Summary" stuff for each package, currently I just > use a toctree with "glob" for the package, might be better to define > content and order for each of them > - define what should go onto the "Tree" quick access - it is shown on > the content pages, e.g. "dApp.dApp.html" > - links/cross references need to be fixed - see below > - clean up of documentation strings within the code > - where appropriate convert some code comments to documentation strings > > Links/cross references problem: > for example "dabo.dObject.dObject" doesn't work but "dObject.dObject" > works, or if I change some stuff then the first one works but not the > second one. I am reporting/asking on the Sphinx list, but if someone > has an idea please let me know. I believe it has to do with the > ":module::" and "currentmodule::" definitions, but I haven't found one > which works for both. > > Feel free to provide comments on everything and anything - just be > kind:-) , as I am not a Sphinx nor Python expert. > > http://thewinecellarbook.com/daboDocTest/ > > Werner > > P.S. > A big thanks to Andrea Gavana (AGW), with his code I would not have > gotten this far!
My first thought was "why do we need another website" but I took a look and I see no harm. In fact it was a refreshing look for Dabo. Of course there still more for you to do. If you need a few screen shots let me know. Johnf _______________________________________________ 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]
