From 391797f888e73b0f28866b274131f67f7a181edc Mon Sep 17 00:00:00 2001 From: Matthieu Caneill Date: Tue, 2 Apr 2024 14:12:32 +0200 Subject: [PATCH] Add reference modules to documentation --- docs/reference/cli.md | 3 +++ docs/reference/exceptions.md | 3 +++ docs/reference/models.md | 3 +++ docs/reference/rule.md | 3 +++ docs/reference/rule_registry.md | 3 +++ docs/reference/rules/generic.md | 3 +++ mkdocs.yml | 8 ++++++++ 7 files changed, 26 insertions(+) create mode 100644 docs/reference/cli.md create mode 100644 docs/reference/exceptions.md create mode 100644 docs/reference/models.md create mode 100644 docs/reference/rule.md create mode 100644 docs/reference/rule_registry.md create mode 100644 docs/reference/rules/generic.md diff --git a/docs/reference/cli.md b/docs/reference/cli.md new file mode 100644 index 0000000..c08166f --- /dev/null +++ b/docs/reference/cli.md @@ -0,0 +1,3 @@ +# CLI + +::: dbt_score.cli diff --git a/docs/reference/exceptions.md b/docs/reference/exceptions.md new file mode 100644 index 0000000..2d12020 --- /dev/null +++ b/docs/reference/exceptions.md @@ -0,0 +1,3 @@ +# Exceptions + +::: dbt_score.exceptions diff --git a/docs/reference/models.md b/docs/reference/models.md new file mode 100644 index 0000000..08c1809 --- /dev/null +++ b/docs/reference/models.md @@ -0,0 +1,3 @@ +# Models + +::: dbt_score.models diff --git a/docs/reference/rule.md b/docs/reference/rule.md new file mode 100644 index 0000000..f4ea06a --- /dev/null +++ b/docs/reference/rule.md @@ -0,0 +1,3 @@ +# Rule + +::: dbt_score.rule diff --git a/docs/reference/rule_registry.md b/docs/reference/rule_registry.md new file mode 100644 index 0000000..3bbc51e --- /dev/null +++ b/docs/reference/rule_registry.md @@ -0,0 +1,3 @@ +# Rule registry + +::: dbt_score.rule_registry diff --git a/docs/reference/rules/generic.md b/docs/reference/rules/generic.md new file mode 100644 index 0000000..53f7f7a --- /dev/null +++ b/docs/reference/rules/generic.md @@ -0,0 +1,3 @@ +# Generic + +::: dbt_score.rules.generic diff --git a/mkdocs.yml b/mkdocs.yml index 87d329e..527899a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,3 +6,11 @@ plugins: - mkdocstrings nav: - Home: index.md + - Reference: + - reference/cli.md + - reference/exceptions.md + - reference/models.md + - reference/rule.md + - Rules: + - reference/rules/generic.md + - reference/rule_registry.md