# AMQ Adapter Python API Documentation

This directory contains the generated HTML API documentation for the AMQ Adapter Python library.

## Viewing the Documentation

1. **Open the main page**: Open `_build/html/index.html` in your web browser
2. **Browse modules**: Use the navigation menu to explore different modules:
   - **Configuration** (`amqp.config`) - Configuration classes and settings
   - **Adapter** (`amqp.adapter`) - Core adapter classes and utilities
   - **Service** (`amqp.service`) - Service layer and message handling
   - **Router** (`amqp.router`) - Routing and service discovery
   - **Model** (`amqp.model`) - Data models and message structures
   - **RabbitMQ** (`amqp.rabbitmq`) - RabbitMQ client implementations

## Features

- **Search functionality**: Use the search box to find specific classes, methods, or functions
- **Module index**: Browse all modules alphabetically
- **Class inheritance**: View class hierarchies and inheritance relationships
- **Source code**: Click "View page source" to see the actual Python code
- **Cross-references**: Navigate between related classes and methods

## Rebuilding the Documentation

To regenerate the documentation after code changes:

```bash
cd api-doc
make html
```

## Documentation Structure

The documentation is organized by module:

- **amqp.config**: Configuration management and settings
- **amqp.adapter**: Core adapter functionality and service integration
- **amqp.service**: Service layer, message handling, and tracing
- **amqp.router**: Routing, service discovery, and queue management
- **amqp.model**: Data models, message structures, and serialization
- **amqp.rabbitmq**: RabbitMQ client implementations and utilities

## Key Classes

- `CleverThisServiceAdapter`: Base class for service adapters
- `AMQService`: Main service class for AMQP operations
- `AMQConfiguration`: Configuration management
- `DataMessage`: Message structure for AMQP communication
- `RouterConsumer`: Service discovery and routing
- `RabbitMQClient`: RabbitMQ connection management