However, overriding docs-paths instead could have unintended side-effects if the dbt project has pre-existing docs blocks within their model-paths, seed-paths, analysis-paths, macro-paths and/or snapshot-paths.
So I'd recommend going the model-paths route rather than the docs-paths route.
Checklist
[x] I have verified that these changes work locally on the following warehouses:
resolves #71
Description & motivation
The
dbt_profiler
dbt package generatesdocs
blocks that are written into thedocs/dbt_profiler
directory.But "docs" isn't included in the default for
docs-paths
, so the"docs"
folder needs to be explicitly added todbt_project.yml
either viamodel-paths
ordocs-paths
.Suggested approach to enable
docs/dbt_profiler
folderThere are two main options:
model-paths
docs-paths
Overriding
model-paths
to be["models", "docs"]
(or extending it to add "docs") will "always work".This is because by default, dbt will search in all resource paths for docs blocks (i.e. the combined list of model-paths, seed-paths, analysis-paths, macro-paths and snapshot-paths).
However, overriding
docs-paths
instead could have unintended side-effects if the dbt project has pre-existingdocs
blocks within theirmodel-paths
,seed-paths
,analysis-paths
,macro-paths
and/orsnapshot-paths
.So I'd recommend going the
model-paths
route rather than thedocs-paths
route.Checklist