-
Notifications
You must be signed in to change notification settings - Fork 198
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Simpler Examples, generate examples pages from actual examples code #1134
Conversation
✅ Deploy Preview for dlt-hub-docs canceled.
|
# Conflicts: # docs/examples/connector_x_arrow/load_arrow.py # docs/examples/custom_destination_bigquery/custom_destination_bigquery.py # docs/examples/google_sheets/google_sheets.py # docs/examples/incremental_loading/incremental_loading.py # docs/examples/pdf_to_weaviate/pdf_to_weaviate.py # docs/examples/transformers/transformers.py
make examples raise in case of failed loads
@@ -0,0 +1,72 @@ | |||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
- How to get arrow tables from [connector X](https://github.com/sfu-db/connector-x) and yield them. | ||
- That merge and incremental loads work with arrow tables. | ||
- How to enable [incremental loading](../general-usage/incremental-loading) for efficient data extraction. | ||
- How to use build in ConnectionString credentials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so we don't have Setup: Running this example on your machine section anymore?
do you think it's useless or it difficult to add in this implementation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it was a feedback from @burnash (at least if i recall correctly) to make these pages more concise. I can add this section back in though, i am not super opinionated on this.
Description
In this PR we fully deduplicate the examples. We generate the examples pages in the docs based on the code in the docs/examples folder, not vice versa.
TODO: