From e40accd6cf0eb8453c04884b44cd0a05e324117b Mon Sep 17 00:00:00 2001 From: Tyler White <50381805+IndexSeek@users.noreply.github.com> Date: Sun, 22 Dec 2024 21:57:03 +0000 Subject: [PATCH] docs: add docs on new .pyiceberg.yaml search path --- mkdocs/docs/api.md | 2 +- mkdocs/docs/cli.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs/docs/api.md b/mkdocs/docs/api.md index b69788ce06..f3d3759d66 100644 --- a/mkdocs/docs/api.md +++ b/mkdocs/docs/api.md @@ -49,7 +49,7 @@ catalog: and loaded in python by calling `load_catalog(name="hive")` and `load_catalog(name="rest")`. -This information must be placed inside a file called `.pyiceberg.yaml` located either in the `$HOME` or `%USERPROFILE%` directory (depending on whether the operating system is Unix-based or Windows-based, respectively) or in the `$PYICEBERG_HOME` directory (if the corresponding environment variable is set). +This information must be placed inside a file called `.pyiceberg.yaml` located either in the `$HOME` or `%USERPROFILE%` directory (depending on whether the operating system is Unix-based or Windows-based, respectively), in the current working directory, or in the `$PYICEBERG_HOME` directory (if the corresponding environment variable is set). For more details on possible configurations refer to the [specific page](https://py.iceberg.apache.org/configuration/). diff --git a/mkdocs/docs/cli.md b/mkdocs/docs/cli.md index 28e44955d7..4e37ddb6e5 100644 --- a/mkdocs/docs/cli.md +++ b/mkdocs/docs/cli.md @@ -26,7 +26,7 @@ hide: Pyiceberg comes with a CLI that's available after installing the `pyiceberg` package. -You can pass the path to the Catalog using the `--uri` and `--credential` argument, but it is recommended to setup a `~/.pyiceberg.yaml` config as described in the [Catalog](configuration.md) section. +You can pass the path to the Catalog using the `--uri` and `--credential` argument, but it is recommended to setup a `~/.pyiceberg.yaml` or `./.pyiceberg.yaml` config as described in the [Catalog](configuration.md) section. ```sh ➜ pyiceberg --help