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

2003-12-11 Thread Yuppie
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

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

2003-12-11 Thread Paul Winkler
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 lat

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

2003-12-10 Thread Brian Lloyd
> 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 wil