From 2fa031886d3d0c72fe0aafa277b27bc7bf5a616e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nina=20=C3=98deg=C3=A5rd?= Date: Tue, 3 Sep 2024 12:03:18 +0200 Subject: [PATCH] docs: include CredentialProviders class in docs (#1904) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Håkon V. Treider --- cognite/client/credentials.py | 4 ++-- docs/source/credential_providers.rst | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/cognite/client/credentials.py b/cognite/client/credentials.py index 86b64d16b..ed5a24421 100644 --- a/cognite/client/credentials.py +++ b/cognite/client/credentials.py @@ -32,8 +32,8 @@ def load(cls, config: dict[str, Any] | str) -> CredentialProvider: Note: The dictionary must contain exactly one top level key, which is the type of the credential provider and must be one of the - following strings: "token", "client_credentials", "interactive", "device_code", "client_certificate". The value of the key - is a dictionary containing the configuration for the credential provider. + following strings: ``"token"``, ``"client_credentials"``, ``"interactive"``, ``"device_code"``, ``"client_certificate"``. + The value of the key is a dictionary containing the configuration for the credential provider. Args: config (dict[str, Any] | str): A dictionary or YAML/JSON string containing the configuration for the credential provider. diff --git a/docs/source/credential_providers.rst b/docs/source/credential_providers.rst index 6b83c12b8..ce5a28223 100644 --- a/docs/source/credential_providers.rst +++ b/docs/source/credential_providers.rst @@ -1,5 +1,8 @@ Credential Providers ==================== +.. autoclass:: cognite.client.credentials.CredentialProvider + :members: + :member-order: bysource .. autoclass:: cognite.client.credentials.Token :members: :member-order: bysource