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

Feature Request: Flag to also generate a doc block readme file #43

Open
hiniko opened this issue Nov 22, 2024 · 0 comments
Open

Feature Request: Flag to also generate a doc block readme file #43

hiniko opened this issue Nov 22, 2024 · 0 comments

Comments

@hiniko
Copy link

hiniko commented Nov 22, 2024

Hi there, unsure if this is the best way to raise a feature request so let me know otherwise!

I'm looking at investing in the dbt docs generate site and I feel that dbt-invoke could make this a lot simpler as it does most of the busy work already generating schema files. by also generating markdown documentation files.

Given the dbt docs, running dbt-invoke with say a --with-docs flag would:

  • create a markdown file in with the same name and location of a model: my_model.sql results in my_model.yml and my_model.md
  • my_model.md contains the docs macro:
{% docs my_model %}
Write your markdown docs here
{% enddocs %}
  • my_model.yml description contains the Jinja template to call the docs:
version: 2
models:
- name: my_model
  description:  '{{ doc("my_model") }}'

Any thoughts on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant