Skip to content

Commit

Permalink
Add reference modules to documentation (#9)
Browse files Browse the repository at this point in the history
`mkdocs` picks up docstrings in Python modules to generate HTML
documentation.
Add all existing modules to the index.
  • Loading branch information
matthieucan authored Apr 3, 2024
1 parent 2b8015d commit 5f414cd
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CLI

::: dbt_score.cli
3 changes: 3 additions & 0 deletions docs/reference/exceptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Exceptions

::: dbt_score.exceptions
3 changes: 3 additions & 0 deletions docs/reference/models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Models

::: dbt_score.models
3 changes: 3 additions & 0 deletions docs/reference/rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Rule

::: dbt_score.rule
3 changes: 3 additions & 0 deletions docs/reference/rule_registry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Rule registry

::: dbt_score.rule_registry
3 changes: 3 additions & 0 deletions docs/reference/rules/generic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Generic

::: dbt_score.rules.generic
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 5f414cd

Please sign in to comment.