asset-paths

dbt_project.yml

asset-paths: [directorypath]

Definition

Optionally specify a custom list of directories to copy to the target directory as part of the docs generate command. This is useful for rendering images in your repository in your project documentation.

Default

By default, dbt will not copy any additional files as part of docs generate. For example, asset-paths: [].

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

• ✅ Do

  • Use relative path:

    asset-paths: ["assets"]

• ❌ Don't

  • Avoid absolute paths:

    asset-paths: ["/Users/username/project/assets"]

Examples

Compile files in the assets subdirectory as part of docs generate

dbt_project.yml

asset-paths: ["assets"]

Any files included in this directory will be copied to the target/ directory as part of dbt docs generate, making them accessible as images in your project documentation.

Check out the full writeup on including images in your descriptions here.