Skip to main content

docs-paths

dbt_project.yml
docs-paths: [directorypath]
Report incorrect code

Definition​

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

Default​

(Applies to dbt v1.9 and later)

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

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"]
      Report incorrect code

  • ❌ Don't

    • Avoid absolute paths: 
      docs-paths: ["/Users/username/project/docs"]
      Report incorrect code

Example​

Use a subdirectory named docs for docs blocks:

dbt_project.yml
docs-paths: ["docs"]
Report incorrect code

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

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

0
Loading