Skip to content

Commit

Permalink
docs(api): Split responses API reference into separate pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
Achronus committed Sep 22, 2024
1 parent 47fa4c3 commit 2f39837
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 20 deletions.
15 changes: 0 additions & 15 deletions docs/api/reference/responses.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/api/reference/responses/base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# zentra_api.responses.base

::: zentra_api.responses.base
3 changes: 3 additions & 0 deletions docs/api/reference/responses/exceptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# zentra_api.responses.exceptions

::: zentra_api.responses.exceptions
5 changes: 5 additions & 0 deletions docs/api/reference/responses/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# zentra_api.responses

API response models to use with API routes. See them in action in the [Route Responses](../route-responses.md) tutorial.

::: zentra_api.responses
3 changes: 3 additions & 0 deletions docs/api/reference/responses/messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# zentra_api.responses.messages

::: zentra_api.responses.messages
3 changes: 3 additions & 0 deletions docs/api/reference/responses/models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# zentra_api.responses.models

::: zentra_api.responses.models
3 changes: 3 additions & 0 deletions docs/api/reference/responses/utils.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# zentra_api.responses.utils

::: zentra_api.responses.utils
2 changes: 1 addition & 1 deletion docs/api/reference/schema.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Schema
# zentra_api.schema

Custom [Pydantic [:material-arrow-right-bottom:]](https://docs.pydantic.dev/latest/) models used throughout the Zentra API package.

Expand Down
10 changes: 9 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,13 @@ nav:
- zentra_api.auth: api/reference/auth.md
- zentra_api.core: api/reference/core.md
- zentra_api.crud: api/reference/crud.md
- zentra_api.responses: api/reference/responses.md
- zentra_api.responses:
- zentra_api.responses: api/reference/responses/index.md
- base: api/reference/responses/base.md
- exceptions: api/reference/responses/exceptions.md
- messages: api/reference/responses/messages.md
- models: api/reference/responses/models.md
- utils: api/reference/responses/utils.md
- zentra_api.schema: api/reference/schema.md
- CLI Commands:
- CLI Commands: api/commands/index.md
Expand Down Expand Up @@ -134,3 +140,5 @@ plugins:
show_object_full_path: true
show_symbol_type_heading: true
show_symbol_type_toc: true
show_object_full_path: false
docstring_style: google
6 changes: 3 additions & 3 deletions poetry.lock

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

0 comments on commit 2f39837

Please sign in to comment.