Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docs for a subset of your dbt project #4217

Merged
merged 3 commits into from
Oct 10, 2023
Merged

Generate docs for a subset of your dbt project #4217

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f80b3b7
Docs Changes Needed from dbt-core PR #8772
dbeatty10 Oct 7, 2023
ea8a5b1
Fix code example
dbeatty10 Oct 7, 2023
ca1ef6c
Merge branch 'current' into dbeatty/dbt-docs-generate-select
matthewshaver Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions website/docs/reference/commands/cmd-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@ The command is responsible for generating your project's documentation website b
dbt docs generate
```

<VersionBlock firstVersion="1.7">

Use the `--select` argument to limit the nodes included within `catalog.json`. When this flag is provided, step (3) will be restricted to the selected nodes. All other nodes will be excluded. Step (2) is unaffected.

**Example**:
```shell
dbt docs generate --select +orders
```

</VersionBlock>


Use the `--no-compile` argument to skip re-compilation. When this flag is provided, `dbt docs generate` will skip step (2) described above.

**Example**:
Expand Down
Loading