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.

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 - dbt-core PR #8772 #4203

Closed
FishtownBuildBot opened this issue Oct 5, 2023 · 0 comments · Fixed by #4217
Closed

generate docs for a subset of your dbt project - dbt-core PR #8772 #4203

FishtownBuildBot opened this issue Oct 5, 2023 · 0 comments · Fixed by #4217
Labels
content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@FishtownBuildBot
Copy link

FishtownBuildBot commented Oct 5, 2023

Docs for dbt-labs/dbt-core#8772

You can now generate docs for a subset of your dbt project, by using the --select flag with dbt docs generate. Selectors will limit the information returned in the catalog.json to only the selected nodes.

dbt docs generate --select ...

At least one page to update:

Examples

Select a single node

Just one node named orders:

dbt docs generate --select orders

Select zero nodes

As already documented here, generate an empty catalog:

dbt docs generate --empty-catalog

Skip compilation

Node selection that affects catalog.json (via --select) can be used in conjunction with --no-compile that affects manifest.json.

As already documented here, skip compiling the resources in your project, so that their compiled_code will be not included in manifest.json:

dbt docs generate --no-compile --select orders
@runleonarun runleonarun added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear dbt Core The changes proposed in this issue relate to dbt Core labels Oct 5, 2023
@graciegoheen graciegoheen changed the title Docs Changes Needed from dbt-core PR #8772 generate docs for a subset of your dbt project - dbt-core PR #8772 Oct 9, 2023
matthewshaver added a commit that referenced this issue Oct 10, 2023
resolves #4203


[Preview](https://docs-getdbt-com-git-dbeatty-dbt-docs-generate-select-dbt-labs.vercel.app/reference/commands/cmd-docs#dbt-docs-generate)


[Production](https://docs.getdbt.com/reference/commands/cmd-docs#dbt-docs-generate)

## What are you changing in this pull request and why?
See #4203

## What was not changed?

After reviewing the following pages, none of them were updated (since
there were no pre-existing code examples or info with this level of
detail):
- https://docs.getdbt.com/docs/collaborate/documentation
- https://docs.getdbt.com/docs/collaborate/build-and-view-your-docs

## 🎩 

<img width="600" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/212797af-c42c-4429-8470-14cae5d4a23a">


## Checklist
- [x] I have tested out any new code examples and confirmed they work
and behave as described
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants