Support for dbt Doc Blocks
dbt Power User provides comprehensive support for dbt doc blocks, allowing you to create, manage, and reference documentation blocks throughout your dbt project.
What are dbt Doc Blocks?
Doc blocks are reusable documentation components in dbt that allow you to define documentation once and reference it multiple times across your project. They're defined in .md
files and can contain any markdown content including text, images, tables, and code snippets.
{% docs doc_description %}
This is a reusable documentation block that can be referenced throughout your dbt project.
{% enddocs %}
Referencing Doc Blocks
In Schema Files
Doc blocks can be referenced in your schema.yml
files for consistent documentation across models:
version: 2
models:
- name: my_model
description: "{{ doc('my_model') }}"
columns:
- name: model_id
description: "{{ doc('model_id') }}"
Propagating Doc Blocks
Using the Propagate Docs Selector - you can select which downstream models you want to propagate docs to: