sicarul / dbtvault-docs

Documentation hosted at https://dbtvault.readthedocs.io/en/latest/

Documentation for dbtvault

Developing

This documentation website uses the mkdocs documentation framework and the material for mkdocs theme.

Modifying

To update any docs, simply edit the corresponding .md files in the docs/ directory.

Running locally

• Ensure that dependencies are installed from the provided Pipfile. Note: Ignore the docs/requirements.txt file for local development. This dependency file is for automated builders.
• Run mkdocs serve from the terminal
• This local website will automatically re-generate itself as you make changes, so no need to close it down.