[Zope-dev] RE: api docs [Was: Re: Post-mortem ...]

Paul Winkler pw_lists at slinkp.com
Thu Dec 11 11:09:20 EST 2003


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)



More information about the Zope-Dev mailing list