Reference¶
Reference material is information-oriented technical descriptions of the machinery and how to operate it. It’s organized around the code and features, describing what they do and how to use them.
Reference Documentation:
What’s Included¶
- API Reference
Complete technical specifications for all functions, classes, and methods.
- Command Line Interface
Full documentation of all CLI commands and options.
- Configuration Options
Comprehensive list of all configuration parameters and their effects.
Using This Reference¶
This section is designed for:
Looking up specific function signatures
Understanding parameter options
Finding exact syntax requirements
Checking return values and types