Principle:Apache Airflow Provider Documentation
| Knowledge Sources | |
|---|---|
| Domains | Documentation, Developer_Experience |
| Last Updated | 2026-02-08 00:00 GMT |
Overview
A documentation framework for provider packages encompassing API references, how-to guides, and example DAGs.
Description
Provider Documentation ensures each provider package has comprehensive documentation including RST-based reference docs, how-to guides linked from provider.yaml, example DAGs in system tests, and auto-generated API references from docstrings. The documentation is built with Sphinx and published alongside the main Airflow documentation on readthedocs.
Usage
Create documentation for every provider following the established templates. Include how-to guides for common use cases, example DAGs demonstrating the provider's operators and sensors, and complete docstrings for all public APIs.
Theoretical Basis
Documentation Hierarchy:
- provider.yaml integrations: Links to how-to guides and external docs
- RST files: Detailed guides in docs/ directory
- Example DAGs: Runnable examples in tests/system/ directory
- API Reference: Auto-generated from Python docstrings via Sphinx
Related Pages
Implemented By
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment