dbt docs #

A standard practice is to populate yaml files that describe models as you build them.

These yaml files can be turned into documentation in a website form.

Generate #

Generate docs with:

dbt docs generate

This scans through all the yaml files in the project and pulls out details.

Generating docs causes:

1. an index.html file to be dropped into target/

2. Compile the documentation into target/manifest.json

3. Create target/catalog.json, which includes metadata about the various tables and views created by the project.

Serve #

dbt docs serve

Serves up the generated documentation as a local website.

Blocks #