docs

Models

models/schema.yml

version: 2
models:  - name: model_name    docs:      show: true | false

Sources

This property is not implemented for sources.

Seeds

data/schema.yml

version: 2
seeds:  - name: seed_name    docs:      show: true | false

Snapshots

snapshots/schema.yml

version: 2
snapshots:  - name: snapshot_name    docs:      show: true | false

Analyses

analysis/schema.yml

version: 2
analyses:  - name: analysis_name    docs:      show: true | false

Macros

macros/schema.yml

version: 2
macros:  - name: macro_name    docs:      show: true | false

Definition

The docs field can be used to provide documentation-specific configuration to models. The only currently supported docs attribute is show, which controls whether or not models are shown in the auto-generated documentation website.

Note: hidden models will still appear in the dbt DAG visualization, but will be identified as "hidden".

▶Changelog

Default

The default value for show is true.

Examples

Mark a model as hidden

models:  - name: sessions__tmp    docs:      show: false