diff --git a/docs/api/catalog.md b/docs/api/catalog.md index d75dd648db..f41c59d3b2 100644 --- a/docs/api/catalog.md +++ b/docs/api/catalog.md @@ -1 +1,7 @@ -::: deltalake.data_catalog.DataCatalog \ No newline at end of file +--- +search: + boost: 2 +--- + + +::: deltalake.data_catalog.DataCatalog diff --git a/docs/api/delta_table/delta_table_merger.md b/docs/api/delta_table/delta_table_merger.md index 7d707a16f2..ce759c05a3 100644 --- a/docs/api/delta_table/delta_table_merger.md +++ b/docs/api/delta_table/delta_table_merger.md @@ -1,3 +1,9 @@ +--- +search: + boost: 2 +--- + + # TableMerger ::: deltalake.table.TableMerger diff --git a/docs/api/delta_table/delta_table_optimizer.md b/docs/api/delta_table/delta_table_optimizer.md index 2275cbd0ca..32d7dcd96a 100644 --- a/docs/api/delta_table/delta_table_optimizer.md +++ b/docs/api/delta_table/delta_table_optimizer.md @@ -1,3 +1,9 @@ +--- +search: + boost: 10 +--- + + # TableOptimizer ::: deltalake.table.TableOptimizer diff --git a/docs/api/delta_table/index.md b/docs/api/delta_table/index.md index 46a65af8d3..b0a96e3a10 100644 --- a/docs/api/delta_table/index.md +++ b/docs/api/delta_table/index.md @@ -1,3 +1,8 @@ +--- +search: + boost: 2 +--- + # DeltaTable ::: deltalake.DeltaTable diff --git a/docs/api/delta_table/metadata.md b/docs/api/delta_table/metadata.md index 92ff62370a..7b4bfabebc 100644 --- a/docs/api/delta_table/metadata.md +++ b/docs/api/delta_table/metadata.md @@ -1,3 +1,9 @@ +--- +search: + boost: 2 +--- + + # Metadata ::: deltalake.Metadata diff --git a/docs/api/delta_writer.md b/docs/api/delta_writer.md index 71c31534b0..432a32b768 100644 --- a/docs/api/delta_writer.md +++ b/docs/api/delta_writer.md @@ -1,7 +1,14 @@ +--- +search: + boost: 10 +--- + # Writer ## Write to Delta Tables ::: deltalake.write_deltalake ## Convert to Delta Tables -::: deltalake.convert_to_deltalake \ No newline at end of file +::: deltalake.convert_to_deltalake + + diff --git a/docs/api/exceptions.md b/docs/api/exceptions.md index afe99f92f1..68a55e1d38 100644 --- a/docs/api/exceptions.md +++ b/docs/api/exceptions.md @@ -1,3 +1,9 @@ +--- +search: + boost: 2 +--- + + # Exceptions ::: deltalake.exceptions.DeltaError diff --git a/docs/api/schema.md b/docs/api/schema.md index 9a6ba7b2e6..7dd51b9b84 100644 --- a/docs/api/schema.md +++ b/docs/api/schema.md @@ -1,3 +1,9 @@ +--- +search: + boost: 2 +--- + + ## Schema and field Schemas, fields, and data types are provided in the ``deltalake.schema`` submodule. diff --git a/docs/api/storage.md b/docs/api/storage.md index ddb18250cf..3c13f22224 100644 --- a/docs/api/storage.md +++ b/docs/api/storage.md @@ -1,3 +1,9 @@ +--- +search: + boost: 2 +--- + + # Storage The delta filesystem handler for the pyarrow engine writer. diff --git a/docs/delta-rust-no-whitespace.svg b/docs/delta-rust-no-whitespace.svg new file mode 100644 index 0000000000..7ac821951a --- /dev/null +++ b/docs/delta-rust-no-whitespace.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/usage/writing-delta-tables.md b/docs/usage/writing-delta-tables.md index 731353984b..fe92572a81 100644 --- a/docs/usage/writing-delta-tables.md +++ b/docs/usage/writing-delta-tables.md @@ -5,7 +5,7 @@ The `data` parameter will accept a Pandas DataFrame, a PyArrow Table, or an iterator of PyArrow Record Batches. ``` python ->>> from deltalake.writer import write_deltalake +>>> from deltalake import write_deltalake >>> df = pd.DataFrame({'x': [1, 2, 3]}) >>> write_deltalake('path/to/table', df) ``` @@ -34,7 +34,7 @@ done on one partition at a time. All of the input data must belong to that partition or else the method will raise an error. ``` python ->>> from deltalake.writer import write_deltalake +>>> from deltalake import write_deltalake >>> df = pd.DataFrame({'x': [1, 2, 3], 'y': ['a', 'a', 'b']}) >>> write_deltalake('path/to/table', df, partition_by=['y']) diff --git a/mkdocs.yml b/mkdocs.yml index a86257c932..fe87bf0284 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,6 +5,32 @@ repo_name: delta-io/delta-rs theme: name: material + logo: delta-rust-no-whitespace.svg + favicon: delta-rust-no-whitespace.svg + + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + primary: indigo + toggle: + icon: material/brightness-auto + name: Switch to light mode + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: indigo + toggle: + icon: material/brightness-4 + name: Switch to system preference locale: en navigation_depth: 3 features: