docs-paths

docs block이 위치한 디렉터리 목록을 지정하는 설정이에요. 기본적으로 dbt는 모든 리소스 경로에서 docs block을 검색해요.

출처: 문서

본문

dbt_project.yml:

docs-paths: [directorypath]

정의 (Definition)

docs block이 위치한 디렉터리 목록을 선택 사항으로 지정해요.

기본값 (Default)

(dbt v1.9 이상에 적용) 기본적으로 dbt는 모든 리소스 경로에서 docs block을 검색해요(예: model-paths, seed-paths, analysis-paths, test-paths, macro-paths, snapshot-paths를 합친 목록). 이 옵션을 설정하면 dbt는 docs block을 지정된 디렉터리에서만 찾아요.

docs-paths에 지정하는 경로는 반드시 dbt_project.yml 파일의 위치를 기준으로 한 상대 경로여야 해요. /Users/username/project/docs 같은 절대 경로는 피하세요. 예상치 못한 동작과 결과를 초래할 수 있어요.

✅ Do · 상대 경로 사용: docs-paths: ["docs"]
❌ Don't · 절대 경로 피하기: docs-paths: ["/Users/username/project/docs"]

예시 (Example)

docs block용으로 docs라는 하위 디렉터리를 사용할 때:

dbt_project.yml:

docs-paths: ["docs"]

참고: dbt의 기본 동작을 선호하기 때문에 보통은 이 설정을 생략해요.

더 알아보기 (Learn more)

프로젝트 설정(dbt_project.yml)의 전체 목록은 Project configurations 문서를 참고하세요.
docs block은 <docs> 태그로 정의하는 재사용 가능한 문서 조각이에요.