Implementation:Apache Airflow Provider Documentation Build

Knowledge Sources	Apache Airflow
Domains	Documentation, Build_System
Last Updated	2026-02-08 00:00 GMT

Overview

Concrete tool for building and publishing provider documentation provided by Sphinx and the provider documentation structure.

Description

Provider documentation uses Sphinx with RST format. The providers-summary-docs/ directory contains the index, package reference, and installation guide. Each provider has its own docs/ directory with how-to guides. Example DAGs in tests/system/ serve as both documentation and integration tests.

Usage

Write RST documentation in the provider's docs/ directory. Reference how-to guides in provider.yaml. Include example DAGs in tests/system/.

Code Reference

Source Location

• Repository: Apache Airflow
• File: providers-summary-docs/index.rst (documentation index)
• File: providers-summary-docs/packages-ref.rst (package reference)
• File: providers-summary-docs/installing-from-pypi.rst (installation guide)
• File: contributing-docs/12_provider_distributions.rst (contribution guide)

Signature

# provider.yaml documentation references
integrations:
  - integration-name: My Service
    external-doc-url: https://myservice.com/docs
    how-to-guide:
      - /docs/howto/my_service_usage.rst
    tags: [service]

Import

# Build documentation
cd docs
sphinx-build -b html . _build/html

# Or use breeze
breeze build-docs --package-filter apache-airflow-providers-example

I/O Contract

Inputs

Name	Type	Required	Description
RST files	Documentation	Yes	reStructuredText documentation files
provider.yaml	Metadata	Yes	Integration how-to-guide references
Example DAGs	Python files	Recommended	System test DAGs as documentation
Docstrings	Python	Recommended	API reference from source code

Outputs

Name	Type	Description
HTML documentation	Website	Published on readthedocs
API reference	HTML	Auto-generated from docstrings

Usage Examples

Documentation Structure

providers/example/
├── docs/
│   ├── howto/
│   │   └── example_usage.rst
│   └── index.rst
├── tests/
│   └── system/
│       └── example/
│           └── example_dag.py
└── provider.yaml  # References docs in integrations section

Related Pages

Implements Principle

• Principle:Apache_Airflow_Provider_Documentation