Reference
Information-oriented technical specifications and API documentation.
Complete reference documentation for NHL Scrabble’s command-line interface, configuration options, and build tools.
Command-Line Interface
Configuration
Build Tools
- Makefile Documentation
- Overview
- Quick Start
- Target Categories
- Installation & Setup
- Testing
- UV Fast Package Manager
- Code Quality
- Security & Dependencies
- Build & Publish
- Documentation
- Running the Application
- Development Utilities
- Release Management
- Cleaning
- All-in-One Workflows
- Utility Targets
- Complete Target Reference
- Common Workflows
- Environment Variables
- Tips & Tricks
- Troubleshooting
- Resources
- Summary
API Documentation
Quick Reference
- Command-Line Interface
- CLI Reference
Complete CLI reference with all commands, options, and arguments
- CLI Reference (Auto-Generated)
Auto-generated CLI documentation from Click decorators
- Configuration
- Configuration Reference
All configuration options and their effects
- Environment Variables Reference
Environment variables for customizing behavior
- Build Tools
- Makefile Documentation
Makefile targets for development, testing, and deployment (55 targets)
- API Documentation
- API Reference (Auto-Generated)
Auto-generated API reference from Python docstrings
Reference Documentation
Reference materials are information-oriented and follow the Diátaxis framework:
Factual - Accurate technical specifications
Complete - Comprehensive coverage of all options
Structured - Organized for easy lookup
Authoritative - The definitive source of truth
How to Use This Reference
- Looking up a specific option?
Use the search function or navigate to the relevant section
- Want complete command syntax?
See CLI Reference for all commands and options
- Need to configure behavior?
Check Environment Variables Reference for available settings
- Understanding the API?
Browse API Reference (Auto-Generated) for module documentation
- Using the Makefile?
See Makefile Documentation for all 55 targets with descriptions
About Auto-Generated Documentation
Some reference pages are auto-generated:
CLI Reference (Auto-Generated) - Generated from Click decorators
API Reference (Auto-Generated) - Generated from Python docstrings with Sphinx autodoc
These pages are automatically updated when code changes, ensuring documentation stays in sync with implementation.