docs-paths

dbt_project.yml

docs-paths: [directorypath]

Definition

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

Default

Paths specified in docs-paths must be relative to the location of your dbt_project.yml file. Avoid using absolute paths like /Users/username/project/docs, as it will lead to unexpected behavior and outcomes.

• ✅ Do

  • Use relative path:

    docs-paths: ["docs"]

• ❌ Don't

  • Avoid absolute paths:

    docs-paths: ["/Users/username/project/docs"]

Example

Use a subdirectory named docs for docs blocks:

dbt_project.yml

docs-paths: ["docs"]

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