Skip to content

Commit

Permalink
Update docs.md
Browse files Browse the repository at this point in the history
fold in Doug's feedback
  • Loading branch information
mirnawong1 authored Dec 19, 2023
1 parent f616860 commit be1c0eb
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions website/docs/reference/resource-configs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,31 +23,29 @@ default_value: {show: true}
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:


<File name='models/schema.yml'>

<File name='dbt_project.yml'>

```yml
version: 2

models:
- name: model_name
docs:
[<resource-path>](/reference/resource-configs/resource-path):
+docs:
show: true | false
node_color: "black"

```

</File>

<File name='dbt_project.yml'>
<File name='models/schema.yml'>

```yml
version: 2

```yml
models:
[<resource-path>](/reference/resource-configs/resource-path):
+docs:
- name: model_name
docs:
show: true | false

node_color: "black"
```

</File>
</TabItem>
Expand Down Expand Up @@ -153,16 +151,14 @@ macros:
```
</File>

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

</TabItem>

</Tabs>

## 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.”
**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`.
Expand Down

0 comments on commit be1c0eb

Please sign in to comment.