docs: include CredentialProviders class in docs (#1904)

Co-authored-by: Håkon V. Treider <[email protected]>
cognitedata · Sep 3, 2024 · 2fa0318 · 2fa0318
1 parent 2c7ec92
commit 2fa0318
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git 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
@@ -1,5 +1,8 @@
 Credential Providers
 ====================
+.. autoclass:: cognite.client.credentials.CredentialProvider
+    :members:
+    :member-order: bysource
 .. autoclass:: cognite.client.credentials.Token
     :members:
     :member-order: bysource