Docs revamp (#13)

* fix typo * docs revamp * index page update * clean up method implementations
dominictarro · Jun 19, 2023 · 5793896 · 5793896
1 parent d6e9888
commit 5793896
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 150 deletions.
diff --git a/docs/batch_task.md → docs/concurrency.md b/docs/batch_task.md → docs/concurrency.md
@@ -1,4 +1,8 @@
-# BatchTask
+# Concurrency
+
+Module for advanced concurrency control.
+
+## BatchTask
 
 ::: src.prefecto.concurrency.BatchTask
     options:

diff --git a/docs/index.md b/docs/index.md
@@ -62,3 +62,19 @@ def flow():
     df = csv_task(df)
     return df
 ```
+
+## Extras
+
+Prefecto includes a number of extras that are not installed by default.
+
+| Extra | Description |
+| --- | --- |
+| `pandas` | Adds support for [`pandas.DataFrame`](./serializers/pandas.md) serialization. |
+| `polars` | Adds support for [`polars.DataFrame`](./serializers/polars.md) serialization. |
+| `moto` | Adds support for mocking AWS's `boto3` with `moto` |
+
+Extras can be installed with
+
+```bash
+pip install prefecto[extra]
+```
diff --git a/docs/serializers/pandas.md b/docs/serializers/pandas.md
@@ -0,0 +1,22 @@
+# Pandas
+
+## PandasSerializer
+
+Type: `pandas`
+
+::: src.prefecto.serializers.pandas.PandasSerializer
+
+## Methods
+
+`Method` classes for serializing `pandas.DataFrame`.
+
+| Discriminator | Default Read | Default Write |
+| --- | --- | --- |
+| `pandas.csv` | `{"index": False}` | `{"index": False}` |
+| `pandas.excel` | None | None |
+| `pandas.feather` | None | None |
+| `pandas.json` | None | None |
+| `pandas.jsonl` | None | None |
+| `pandas.parquet` | None | None |
+| `pandas.pickle` | None | None |
+| `pandas.tsv` | `{"sep": "\t", "index": False}` | `{"sep": "\t", "index": False}` |
diff --git a/docs/serializers/pandas/methods.md b/docs/serializers/pandas/methods.md
diff --git a/docs/serializers/pandas/pandas_serializer.md b/docs/serializers/pandas/pandas_serializer.md
diff --git a/docs/serializers/polars.md b/docs/serializers/polars.md
@@ -0,0 +1,22 @@
+# Polars
+
+Serialization module for for the `polars.DataFrame` type.
+
+## PolarsSerializer
+
+Type: `polars`
+
+::: src.prefecto.serializers.polars.PolarsSerializer
+
+## Methods
+
+`Method` classes for serializing `polars.DataFrame`.
+
+| Discriminator | Default Read | Default Write |
+| --- | --- | --- |
+| `polars.csv` | None | None |
+| `polars.excel` | None | None |
+| `polars.json` | None | None |
+| `polars.ndjson` | None | None |
+| `polars.parquet` | None | None |
+| `polars.tsv` | `{"separator": "\t"}` | `{"separator": "\t"}` |
diff --git a/docs/serializers/polars/methods.md b/docs/serializers/polars/methods.md
diff --git a/docs/serializers/polars/polars_serializer.md b/docs/serializers/polars/polars_serializer.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,23 +4,20 @@ repo_url: https://github.com/dominictarro/prefecto
 theme: readthedocs
 
 nav:
-  - Home: index.md
-  - "Concurrency":
-    - batch_task.md
-  - "File Systems": filesystems.md
-  - "Serialization":
-    - serializers/extended_serializer.md
-    - serializers/method.md
-    - serializers/functions.md
-    - "Pandas":
-      - serializers/pandas/pandas_serializer.md
-      - serializers/pandas/methods.md
-    - "Polars":
-      - serializers/polars/polars_serializer.md
-      - serializers/polars/methods.md
-  - "Testing":
-    - testing/s3.md
+  - "Home": index.md
   - "License": license.md
+  - "Reference":
+    - "Concurrency": concurrency.md
+    - "File Systems": filesystems.md
+    - "Serialization":
+      - serializers/extended_serializer.md
+      - serializers/method.md
+      - serializers/functions.md
+      - "Custom Serializers":
+        - "Pandas": serializers/pandas.md
+        - "Polars": serializers/polars.md
+    - "Testing":
+      - testing/s3.md
 
 plugins: 
   - search:

diff --git a/src/prefecto/concurrency.py b/src/prefecto/concurrency.py
@@ -1,5 +1,5 @@
 """
-Tools to improve Prefect concurrently.
+Tools to improve Prefect concurrency.
 
 """
 from __future__ import annotations