docs
- Models
- Sources
- Seeds
- Snapshots
- Analyses
- Macros
You can configure docs
behavior for many resources at once by setting in dbt_project.yml
. You can also use the docs
config in properties.yaml
files, to set or override documentation behaviors for specific resources:
models:
<resource-path>:
+docs:
show: true | false
version: 2
models:
- name: model_name
docs:
show: true | false
node_color: "black"
This property is not implemented for sources.
You can use the docs property in YAML files, including the dbt_project.yml
:
seeds:
<resource-path>:
+docs:
show: true | false
version: 2
seeds:
- name: seed_name
docs:
show: true | false
You can use the docs property in YAML files, including the dbt_project.yml
:
snapshots:
<resource-path>:
+docs:
show: true | false
version: 2
snapshots:
- name: snapshot_name
docs:
show: true | false
You can use the docs property in YAML files, except in dbt_project.yml
. Refer to Analysis properties for more info.
version: 2
analyses:
- name: analysis_name
docs:
show: true | false
You can use the docs property in YAML files, except in dbt_project.yml
. Refer to Macro properties for more info.
version: 2
macros:
- name: macro_name
docs:
show: true | false
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