API Reference

APIDoc

Zope 3 API Documentation

Class Registry

Class Registry

Component

Component Inspection Utilities

Stubs for when documentation is disabled.

Interface

Interface Inspection Utilities

Interfaces

Generic API Documentation Interfaces

Presentation

Views/Presentation Utilities

Static

Retrieve Static APIDOC

Utilities

Utilties to make the life of Documentation Modules easier.

Browser

Main API Documentation View

API Documentation macros

API Doc Preference Views

APIdoc skin.

Common Utilities for Browser View

Book

Help books.

Configuration

Meta-Configuration Handlers for “apidoc:bookchapter” directive.

Schema for the apidoc:bookchapter directive

Browser

Browser Views for Book

Code

Code Documentation Module

This module is able to take a dotted name of any class and display documentation for it.

Interfaces

Interfaces for code browser

Classes

Class representation for code browser

Functions

Function representation for code browser

Modules

Module representation for code browser

Text

Function representation for code browser

ZCML

ZCML File Representation

Configuration

This module handles the ‘apidoc:rootModule’ and ‘apidoc:moduleImport’ namespace directives.

apidoc ZCML namespace directive interfaces

Browser

Class Views

Function Views

Introspector view for content components

Code Module Menu

Module Views

Browser utilities for API documentation.

Function Views

ZCML Element Views

Interfaces

Interface Documentation Module

The interface documentation module retrieves its information from the site manager. Therefore, currently there are no unregsitered interfaces listed in the documentation. This might be good, since unregistered interfaces are usually private and not of interest to a general developer.

Interfaces

Interface Documentation Module Interfaces

Browser

Interface Details View

API Documentation macros

Interface Module Browser Menu (Tree)

Types

Interface Types Documentation Module

Browser

Browser Views for Interface Types

Utilities

Utility Documentation Module

Browser

Utility Module Views

ZCML

ZCML Documentation module

The ZCML documentation module reads all of the meta directives (but does not execute them) and uses the collected data to generate the tree. The result of the evaluation is stored in thread-global variables, so that we have to parse the files only once.

Browser

Browser Views for ZCML Reference