Zope siempre ha sido acusado de estar poco o mal documentado.
Bueno, yo pienso radicalmente lo contrario, como muchos de la comunidad, pero nunca está bien acomodarse en una postura y despreciar la opinión de otros por infundada que te parezca.
Si actuamos de abogados del diablo, hacemos un esfuerzo de empatía y nos ponemos en el lugar del que se acerca a zope3 por primera vez, nos damos cuenta que la documentación de Zope no está muy visible.
Cada instalación de zope tiene una documentación del api generada de forma dinámica que explica de forma exhaustiva cada método, clase, interfaz y adaptador de los que tiene Zope.
¿Cómo no va a estar zope documentado si cada declaración de función o clase lleva incluida la propia documentación? Gracias a la herramienta apidoc, podemos hacer en cualquier momento un ejercicio de introspección sobre cualquier objeto Python y leer cómodamente su documentación.
Pero lo que la gente aprecia como buena documentación es una URL (una sola), que apunte a una sección de un web site (uno solo), donde aparezca toda la documentación disponible, donde uno por uno se describa cada objeto, clase, interfaz o adpatador de Zope.
Bien, uno de los frutos del Foliage Sprint, celebrado la semana pasada está, precisamente, relacionado con esta hambre de documentación.
Julian Bonilla, Graham Stratton y Stephan Richter han completado la tarea de crear una versión estática de la documentación del API de Zope3, para poder dejarla disponble en una URL en zope.org
Para que no se diga que no hay documentación de Zope3: