Skip to content

Auto-generated data documentation site for dbt projects

License

Notifications You must be signed in to change notification settings

duneanalytics/dbt-docs

 
 

Repository files navigation

dbt docs

dbt helps analysts write reliable, modular code using a workflow that closely mirrors software development.

This repository contains code for generating a documentation site for dbt projects. Check out the dbt documentation for more information.


Getting Started

Code of Conduct

Everyone interacting in the dbt project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

Showing dbt docs

In your dbt project, run dbt docs generate then dbt docs serve.

Development

After cloning this repository, run:

git submodule update --init --recursive

You'll also need to install bundler if you don't already have it:

gem install bundler
bundle install

Build / Run

To build the css files required for webpack:

cd styles
bundle exec jekyll build
cd -

To build an index.html file:

npm install
npx webpack

To run the dev server, first copy your manifest.json and catalog.json files to the src/ directory. Then run:

npm install
npm start

About

Auto-generated data documentation site for dbt projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 67.9%
  • HTML 30.9%
  • Other 1.2%