docs-paths

dbt_project.yml

docs-paths: [directorypath]

Definition

Optionally specify a custom list of directories where docs blocks are located.

Default

By default, dbt will search in all resource paths for docs blocks (i.e. the combined list of source-paths, data-paths, analysis-paths, macro-paths and snapshot-paths). If this option is configured, dbt will only look in the specified directory for docs blocks.

Examples

info

We typically omit this configuration as we prefer dbt's default behavior.

Use a subdirectory named docs for docs blocks

dbt_project.yml

docs-paths: ["docs"]