docs

Models

models/schema.yml

version: 2

models:
  - name: model_name
    docs:
      show: true | false
      node_color: "black"

Sources

This property is not implemented for sources.

Seeds

seeds/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

Also refer to [macro properties](/reference/macro-properties).

Definition

The docs field can be used to provide documentation-specific configuration to models. It supports the doc attribute show, which controls whether or not models are shown in the auto-generated documentation website. It also supports node_color for some node types.

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

Default

The default value for show is true.

Examples

Mark a model as hidden

models:
  - name: sessions__tmp
    docs:
      show: false