docs updated

igorbenav · Feb 20, 2024 · 2900771 · 2900771
1 parent c3c7499
commit 2900771
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -18,6 +18,10 @@ Our application's API is comprised of several key components, each serving a spe
 
     - [CRUD Router Function Reference](crud_router.md)
 
+4. **paginated Module**: A a utility module for offset pagination related functions.
+
+    - [Pagination Module Reference](paginated.md)
+
 ## Usage
 
 Each component is documented with its own dedicated page, where you can find detailed information about its methods, parameters, return types, and usage examples. These pages are designed to provide you with all the information you need to understand and work with our API effectively.

diff --git a/docs/api/paginated.md b/docs/api/paginated.md
@@ -0,0 +1,9 @@
+# Paginated Module Reference
+
+`paginated` is a utility module for offset pagination related functions.
+
+## Function Definition
+
+::: fastcrud.paginated
+    rendering:
+      show_if_no_docstring: true
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -59,6 +59,7 @@ nav:
     - FastCRUD: api/fastcrud.md
     - EndpointCreator: api/endpoint_creator.md
     - crud_router: api/crud_router.md
+    - paginated: api/paginated.md
   - Community:
     - Overview: community/overview.md
     - Contributing: community/CONTRIBUTING.md