API Reference (Auto-Generated)

⚠️ Auto-Generated Documentation

This directory contains auto-generated API reference documentation. DO NOT EDIT MANUALLY - Changes will be overwritten.

To update: make docs-api or pdoc nhl_scrabble -o docs/reference/api

Overview

The NHL Scrabble API reference provides complete documentation for all public modules, classes, and functions in the nhl_scrabble package.

This documentation is automatically generated from docstrings using pdoc, ensuring it always matches the current codebase.

Browse API Documentation

Main Modules

  • CLI - Command-line interface (nhl_scrabble.cli)

  • API Client - NHL API client (nhl_scrabble.api.nhl_client)

  • Models - Data models (nhl_scrabble.models)

  • Scoring - Scrabble scoring logic (nhl_scrabble.scoring)

  • Processors - Business logic (nhl_scrabble.processors)

  • Reports - Report generators (nhl_scrabble.reports)

  • Configuration - Configuration management (nhl_scrabble.config)

  • Logging - Logging configuration (nhl_scrabble.logging_config)

  • Security - Security utilities (nhl_scrabble.security)

Documentation Quality

This API reference is built from:

  • ✅ 100% docstring coverage (enforced by interrogate)

  • ✅ Comprehensive type hints (strict mypy compliance)

  • ✅ PEP 257 docstring format (Google-style)

  • ✅ Detailed examples (working code samples)

For Developers

Regenerating Documentation

After updating docstrings or adding new modules:

# Regenerate API docs
make docs-api

# Or directly with pdoc
pdoc nhl_scrabble -o docs/reference/api

Viewing Locally

Open index.html in your browser:

# Linux/macOS
xdg-open docs/reference/api/index.html
# or
open docs/reference/api/index.html

# Windows
start docs/reference/api/index.html

CI Integration

The CI pipeline checks that generated documentation is up-to-date:

# Check if docs need regeneration
make docs-check

External Resources

Generated by pdoc - Auto-updated with code changes