Skip to content

Commit

Permalink
docs: separate pages for each module
Browse files Browse the repository at this point in the history
  • Loading branch information
lmmx committed Mar 3, 2024
1 parent 29d4d51 commit d6386e1
Show file tree
Hide file tree
Showing 10 changed files with 37 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/api/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: mvdef.cli
1 change: 1 addition & 0 deletions docs/api/core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: mvdef.core
1 change: 1 addition & 0 deletions docs/api/error_handling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: mvdef.error_handling
3 changes: 3 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# API Reference

::: mvdef
options:
members:
- __init__
1 change: 1 addition & 0 deletions docs/api/legacy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: mvdef.legacy
1 change: 1 addition & 0 deletions docs/api/log_utils.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: mvdef.log_utils
1 change: 1 addition & 0 deletions docs/api/transfer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: mvdef.transfer
1 change: 1 addition & 0 deletions docs/api/whitespace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: mvdef.whitespace
8 changes: 7 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ plugins:
cards_layout_options:
color: #173a58


nav:
- Home: index.md
- Getting Started:
Expand All @@ -109,3 +108,10 @@ nav:
- reference/index.md
- API:
- api/index.md
- api/cli.md
- api/core.md
- api/error_handling.md
- api/legacy.md
- api/log_utils.md
- api/transfer.md
- api/whitespace.md
26 changes: 20 additions & 6 deletions pdm.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d6386e1

Please sign in to comment.