Skip to content

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

@hiniko

Description

@hiniko

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions