From daf8f15ade6ccb103e4748fc2dfd88c41a850a6a Mon Sep 17 00:00:00 2001 From: Doug Guthrie Date: Tue, 5 Dec 2023 11:46:06 -0700 Subject: [PATCH] Fix docs to use headings --- docs/guide/cloud.md | 63 ++++++++++++++++++++++++++++++++++++++++++--- mkdocs.yml | 3 +-- 2 files changed, 61 insertions(+), 5 deletions(-) diff --git a/docs/guide/cloud.md b/docs/guide/cloud.md index 60d122d..cf7dbca 100644 --- a/docs/guide/cloud.md +++ b/docs/guide/cloud.md @@ -5,6 +5,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Account +### get_account ::: dbtc.client.admin._AdminClient.get_account **Examples:** @@ -22,6 +23,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-account ``` +### get_account_by_name ::: dbtc.client.admin._AdminClient.get_account_by_name **Examples:** @@ -38,6 +40,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-account-by-name --account-name=name ``` +### get_account_licenses ::: dbtc.client.admin._AdminClient.get_account_licenses **Examples:** @@ -55,6 +58,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-account-licenses ``` +### list_accounts ::: dbtc.client.admin._AdminClient.list_accounts **Examples:** @@ -73,6 +77,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Artifact +### get_most_recent_run_artifact ::: dbtc.client.admin._AdminClient.get_most_recent_run_artifact **Examples:** @@ -90,6 +95,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-most-recent-run-artifact --path manifest.json ``` +### get_run_artifact ::: dbtc.client.admin._AdminClient.get_run_artifact **Examples:** @@ -107,6 +113,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-run-artifact --run-id=1 --path=manifest.json ``` +### list_run_artifacts ::: dbtc.client.admin._AdminClient.list_run_artifacts **Examples:** @@ -126,6 +133,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Audit Log +### list_audit_logs ::: dbtc.client.admin._AdminClient.list_audit_logs **Examples:** @@ -145,6 +153,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Connection +### create_adapter ::: dbtc.client.admin._AdminClient.create_adapter **Examples:** @@ -176,6 +185,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### create_connection ::: dbtc.client.admin._AdminClient.create_connection **Examples:** @@ -262,6 +272,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### delete_connection ::: dbtc.client.admin._AdminClient.delete_connection **Examples:** @@ -280,6 +291,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc delete-connection --connection-id=1 ``` +### list_connections ::: dbtc.client.admin._AdminClient.list_connections **Examples:** @@ -299,12 +311,14 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-connections ``` +### test_connection ::: dbtc.client.admin._AdminClient.test_connection - +### update_connection ::: dbtc.client.admin._AdminClient.update_connection ## Credentials +### create_credentials ::: dbtc.client.admin._AdminClient.create_credentials **Examples:** @@ -336,6 +350,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### list_credentials ::: dbtc.client.admin._AdminClient.list_credentials **Examples:** @@ -354,12 +369,14 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-credentials ``` +### update_credentials ::: dbtc.client.admin._AdminClient.update_credentials ## Environment +### create_environment ::: dbtc.client.admin._AdminClient.create_environment - +### delete_environment ::: dbtc.client.admin._AdminClient.delete_environment **Examples:** @@ -378,6 +395,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc delete-environment --environment-id=1 ``` +### list_environments ::: dbtc.client.admin._AdminClient.list_environments **Examples:** @@ -396,10 +414,12 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-environments ``` +### update_environment ::: dbtc.client.admin._AdminClient.update_environment ## Environment Variables +### create_environment_variables ::: dbtc.client.admin._AdminClient.create_environment_variables **Examples:** @@ -433,6 +453,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### delete_environment_variables ::: dbtc.client.admin._AdminClient.delete_environment_variables **Examples:** @@ -461,6 +482,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Feature Flags +### list_feature_flags ::: dbtc.client.admin._AdminClient.list_feature_flags **Examples:** @@ -480,6 +502,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Group +### assign_group_permissions ::: dbtc.client.admin._AdminClient.assign_group_permissions **Examples:** @@ -514,6 +537,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ] ``` +### assign_user_to_group ::: dbtc.client.admin._AdminClient.assign_user_to_group **Examples:** @@ -541,6 +565,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### create_user_group ::: dbtc.client.admin._AdminClient.create_user_group **Examples:** @@ -569,6 +594,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### delete_user_group ::: dbtc.client.admin._AdminClient.delete_user_group **Examples:** @@ -599,6 +625,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### list_groups ::: dbtc.client.admin._AdminClient.list_groups **Examples:** @@ -618,6 +645,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Job +### create_job ::: dbtc.client.admin._AdminClient.create_job **Examples:** @@ -672,6 +700,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### delete_job ::: dbtc.client.admin._AdminClient.delete_job **Examples:** @@ -689,6 +718,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc delete-environment --job-id=1 ``` +### get_job ::: dbtc.client.admin._AdminClient.get_job **Examples:** @@ -706,6 +736,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-job --job-id=1 ``` +### list_jobs ::: dbtc.client.admin._AdminClient.list_jobs **Examples:** @@ -723,16 +754,21 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-jobs ``` +### trigger_autoscaling_ci_job ::: dbtc.client.admin._AdminClient.trigger_autoscaling_ci_job +### trigger_job ::: dbtc.client.admin._AdminClient.trigger_job +### trigger_job_from_failure ::: dbtc.client.admin._AdminClient.trigger_job_from_failure +### update_job ::: dbtc.client.admin._AdminClient.update_job ## Repository +### create_repository ::: dbtc.client.admin._AdminClient.create_repository **Examples:** @@ -764,6 +800,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### delete_repository ::: dbtc.client.admin._AdminClient.delete_repository **Examples:** @@ -782,6 +819,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc delete-repository --repository-id=1 ``` +### list_repositories ::: dbtc.client.admin._AdminClient.list_repositories **Examples:** @@ -800,10 +838,12 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-repositories ``` +### update_repository ::: dbtc.client.admin._AdminClient.update_repository ## Run +### cancel_run ::: dbtc.client.admin._AdminClient.cancel_run **Examples:** @@ -821,6 +861,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ```bash dbtc cancel-run --account-id=1 --run-id=1 +### get_most_recent_run ::: dbtc.client.admin._AdminClient.get_most_recent_run **Examples:** @@ -838,6 +879,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-most-recent-run ``` +### get_run ::: dbtc.client.admin._AdminClient.get_run **Examples:** @@ -855,6 +897,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-run --run-id=1 ``` +### get_run_timing_details ::: dbtc.client.admin._AdminClient.get_run_timing_details **Examples:** @@ -873,6 +916,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-run-timing-details --run-id=1 ``` +### list_runs ::: dbtc.client.admin._AdminClient.list_runs **Examples:** @@ -892,6 +936,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## Project +### create_project ::: dbtc.client.admin._AdminClient.create_project **Examples:** @@ -922,6 +967,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### delete_project ::: dbtc.client.admin._AdminClient.delete_project **Examples:** @@ -940,6 +986,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc delete-project ``` +### get_project ::: dbtc.client.admin._AdminClient.get_project **Examples:** @@ -958,6 +1005,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-project ``` +### get_project_by_name ::: dbtc.client.admin._AdminClient.get_project_by_name **Examples:** @@ -975,6 +1023,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-project --project-name=name ``` +### list_projects ::: dbtc.client.admin._AdminClient.list_projects **Examples:** @@ -992,10 +1041,12 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-projects ``` +### update_project ::: dbtc.client.admin._AdminClient.update_project ## Service Token +### assign_service_token_permissions ::: dbtc.client.admin._AdminClient.assign_service_token_permissions **Examples:** @@ -1071,6 +1122,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### get_service_token ::: dbtc.client.admin._AdminClient.get_service_token **Examples:** @@ -1088,6 +1140,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get-service-token --service-token-id=1 ``` +### list_service_tokens ::: dbtc.client.admin._AdminClient.list_service_tokens **Examples:** @@ -1105,6 +1158,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-service-tokens ``` +### list_service_token_permissions ::: dbtc.client.admin._AdminClient.list_service_token_permissions **Examples:** @@ -1124,6 +1178,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ## User +### deactivate_user_license ::: dbtc.client.admin._AdminClient.deactivate_user_license **Examples:** @@ -1239,6 +1294,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a } ``` +### get_user ::: dbtc.client.admin._AdminClient.get_user **Examples:** @@ -1256,6 +1312,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc get_user --user-id=1 ``` +### list_invited_users ::: dbtc.client.admin._AdminClient.list_invited_users **Examples:** @@ -1273,6 +1330,7 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a dbtc list-invited-users ``` +### list_users ::: dbtc.client.admin._AdminClient.list_users **Examples:** @@ -1289,4 +1347,3 @@ The `cloud` property on the `dbtCloudClient` class contains methods that allow a ```bash dbtc list-users ``` - \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b588d83..a96cd58 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -111,5 +111,4 @@ plugins: python: options: show_source: true - show_symbol_type_toc: true - heading_level: 3 \ No newline at end of file + show_root_toc_entry: false