Re: [Zope-dev] RE: api docs [Was: Re: Post-mortem ...]
On Wed, Dec 10, 2003 at 10:20:22AM -0500, Brian Lloyd wrote: Ghaaa... :( API docs come from OFSP/help, so you'll probably have to copy it for now. As you rightly pointed out, this is problematic for keeping things in sync, but we should hold our nose for now and do it, since it's too late in the 2.7 cycle to contemplate that big a restructuring. Making this sane would be a good potential project for an enterprising zopista for 2.8... What would be sane in your view? Using interfaces for help, as CMF does? I was curious how CMF sets this up, and found the following in CMFCore/__init__.py: try: context.registerHelpTitle( 'CMF Core Help' ) context.registerHelp(directory='interfaces') except: # AARGH!! pass I love comments like that :-) -- Paul Winkler http://www.slinkp.com Look! Up in the sky! It's THE EXPECTANT MOLE RAT! (random hero from isometric.spaceninja.com) ___ Zope-Dev maillist - [EMAIL PROTECTED] http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
[Zope-dev] Re: api docs [Was: Re: Post-mortem ...]
Hi! Paul Winkler wrote: What would be sane in your view? Using interfaces for help, as CMF does? I was curious how CMF sets this up, and found the following in CMFCore/__init__.py: try: context.registerHelpTitle( 'CMF Core Help' ) context.registerHelp(directory='interfaces') except: # AARGH!! pass I love comments like that :-) This bare except is removed in CMF HEAD, it's not necessary for current Zope versions. http://cvs.zope.org/CMF/CMFCore/__init__.py.diff?r1=1.24r2=1.25 But there are other issues with this approach. I never got a reply to this mail: http://mail.zope.org/pipermail/zope-dev/2002-November/018103.html Maybe the Zope X3 Introspector is a sane solution? Cheers, Yuppie ___ Zope-Dev maillist - [EMAIL PROTECTED] http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
[Zope-dev] RE: api docs [Was: Re: Post-mortem ...]
What is the Right Way to keep api docs in sync? Example 1: ZCatalog/IZCatalog.py seems to be more up to date, but ZCatalog/help/ZCatalog.py is used by the Zope Help System and I guess also to generate api docs. Example 2: I did add OFS/IOrderSupport.py, but how will it become part of help and api docs? Is there a better way than copying it to OFSP/help? I hate to add redundant code because - as example 1 shows - it is hard to keep the files in sync. CMF uses the interface files also as help files. As interface files become more and more common in Zope it might make sense to do the same in Zope. Ghaaa... :( API docs come from OFSP/help, so you'll probably have to copy it for now. As you rightly pointed out, this is problematic for keeping things in sync, but we should hold our nose for now and do it, since it's too late in the 2.7 cycle to contemplate that big a restructuring. Making this sane would be a good potential project for an enterprising zopista for 2.8... Brian Lloyd[EMAIL PROTECTED] V.P. Engineering 540.361.1716 Zope Corporation http://www.zope.com ___ Zope-Dev maillist - [EMAIL PROTECTED] http://mail.zope.org/mailman/listinfo/zope-dev ** No cross posts or HTML encoding! ** (Related lists - http://mail.zope.org/mailman/listinfo/zope-announce http://mail.zope.org/mailman/listinfo/zope )
