Skip to content

Commit

Permalink
docs: update code ref
Browse files Browse the repository at this point in the history
  • Loading branch information
JasperHG90 committed Nov 19, 2024
1 parent f64fe57 commit 4af1ff3
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 11 deletions.
18 changes: 11 additions & 7 deletions docs/code_reference.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
::: dagster_pyiceberg
## Resources

::: dagster_pyiceberg.io_manager
::: dagster_pyiceberg.resource.IcebergTableResource

::: dagster_pyiceberg.io_manager.arrow
## IO Managers

::: dagster_pyiceberg.io_manager.polars
::: dagster_pyiceberg.io_manager.arrow.IcebergPyarrowIOManager

::: dagster_pyiceberg.io_manager.daft
::: dagster_pyiceberg.io_manager.polars.IcebergPolarsIOManager

::: dagster_pyiceberg.io_manager.pandas
::: dagster_pyiceberg.io_manager.daft.IcebergDaftIOManager

::: dagster_pyiceberg.resource
::: dagster_pyiceberg.io_manager.pandas.IcebergPandasIOManager

## Base classes

::: dagster_pyiceberg.handler.IcebergBaseTypeHandler

::: dagster_pyiceberg.io_manager.base.IcebergIOManager
2 changes: 1 addition & 1 deletion docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ If you want to store assets in different schemas, you can specify the schema as

In this example, the `iris_dataset` asset will be stored in the `IRIS` schema, and the `daffodil_dataset` asset will be found in the `DAFFODIL` schema.

!!! info "Installing dagster-pyiceberg-pandas"
!!! info "Specifying a schema"

The two options for specifying schema are mutually exclusive. If you provide{" "}
<code>schema</code> configuration to the I/O manager, you cannot also provide
Expand Down
28 changes: 25 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,29 @@ plugins:
handlers:
python:
paths:
- packages/dagster_pyiceberg
- packages/dagster_pyiceberg_pandas
- packages/dagster_pyiceberg_polars
- src/dagster_pyiceberg
options:
docstring_options:
ignore_init_summary: true
docstring_section_style: list
filters: ["!^_"]
heading_level: 1
inherited_members: true
merge_init_into_class: true
parameter_headings: true
preload_modules: [mkdocstrings]
relative_crossrefs: true
scoped_crossrefs: true
separate_signature: true
show_bases: false
show_inheritance_diagram: true
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_source: false
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
unwrap_annotated: true
- include-markdown

0 comments on commit 4af1ff3

Please sign in to comment.