Fix broken links caused by updated (#1002) (#1003)

* Fix broken links due to new integration docs * Fix broken links in core api docs * Adjust the get_api_docs function to work with the new api docs (cherry picked from commit f5ec3c8)
zenml-io · Oct 25, 2022 · ab810a9 · ab810a9
1 parent c616db9
commit ab810a9
Show file tree

Hide file tree

Showing 58 changed files with 91 additions and 89 deletions.
diff --git a/docs/book/advanced-guide/pipelines/containerization.md b/docs/book/advanced-guide/pipelines/containerization.md
@@ -40,7 +40,7 @@ This section covers all the different ways in which you can hook into the Docker
 process to customize the resulting image to your needs.
 
 For a full list of configuration options, check out
-[our API Docs](https://apidocs.zenml.io/latest/api_docs/config/#zenml.config.docker_settings.DockerSettings).
+[our API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-config/#zenml.config.docker_settings.DockerSettings).
 
 For the configuration examples described below, you'll need to import the `DockerSettings` class:
 ```python

diff --git a/docs/book/advanced-guide/pipelines/materializers.md b/docs/book/advanced-guide/pipelines/materializers.md
@@ -95,7 +95,7 @@ important, as the artifact type is only used as a tag in the visualization tools
 
 {% hint style="info" %} 
 You can find a full list of available artifact types in the 
-[API Docs](https://apidocs.zenml.io/latest/api_docs/artifacts/).
+[API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-artifacts/).
 {% endhint %}
 
 ### Where to Store the Artifact
@@ -412,7 +412,7 @@ Materializers link pythonic types to artifact types implicitly. E.g., a
 `ModelArtifact` implicitly via their materializers.
 
 You can find a full list of available artifact types in the 
-[API Docs](https://apidocs.zenml.io/latest/api_docs/artifacts/).
+[API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-artifacts/).
 {% endhint %}
 
 ### Example

diff --git a/docs/book/advanced-guide/pipelines/step-metadata.md b/docs/book/advanced-guide/pipelines/step-metadata.md
@@ -75,7 +75,7 @@ def my_step(context: StepContext):
 ```
 
 {% hint style="info" %}
-See the [API Docs](https://apidocs.zenml.io/latest/api_docs/steps/) for
+See the [API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-steps/) for
 more information on which attributes and methods the `StepContext` provides.
 {% endhint %}
 
@@ -105,5 +105,5 @@ def my_step(...)
 {% hint style="info" %}
 To explore all possible operations that can be performed via the
 `Environment`, please consult the API docs section on
-[Environment](https://apidocs.zenml.io/latest/api_docs/environment/#zenml.environment.Environment).
+[Environment](https://apidocs.zenml.io/latest/core_code_docs/core-environment/#zenml.environment.Environment).
 {% endhint %}
diff --git a/docs/book/component-gallery/alerters/slack.md b/docs/book/component-gallery/alerters/slack.md
@@ -8,10 +8,10 @@ The `SlackAlerter` enables you to send messages to a dedicated Slack
 channel directly from within your pipelines.
 
 The `slack` integration also contains the following two standard steps:
-- [slack_alerter_post_step](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.slack.steps.slack_alerter_post_step.slack_alerter_post_step) 
+- [slack_alerter_post_step](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-slack/#zenml.integrations.slack.steps.slack_alerter_post_step.slack_alerter_post_step) 
 takes a string, posts it to Slack, and returns `True` if the operation 
 succeeded, else `False`.
-- [slack_alerter_ask_step](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.slack.steps.slack_alerter_ask_step.slack_alerter_ask_step) 
+- [slack_alerter_ask_step](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-slack/#zenml.integrations.slack.steps.slack_alerter_ask_step.slack_alerter_ask_step) 
 does the same as `slack_alerter_post_step`, but after sending the message, it 
 waits until someone approves or rejects the operation from within Slack
 (e.g., by sending "approve" / "reject" to the bot in response).
@@ -82,8 +82,8 @@ zenml stack register ... -al slack_alerter
 ### How to Use the Slack Alerter
 
 After you have a `SlackAlerter` configured in your stack, you can directly import the 
-[slack_alerter_post_step](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.slack.steps.slack_alerter_post_step.slack_alerter_post_step) and
-[slack_alerter_ask_step](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.slack.steps.slack_alerter_ask_step.slack_alerter_ask_step)
+[slack_alerter_post_step](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-slack/#zenml.integrations.slack.steps.slack_alerter_post_step.slack_alerter_post_step) and
+[slack_alerter_ask_step](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-slack/#zenml.integrations.slack.steps.slack_alerter_ask_step.slack_alerter_ask_step)
 steps and use them in your pipelines.
 
 Since these steps expect a string message as input (which needs to be the 
@@ -128,4 +128,4 @@ model deployment until a user approves it in Slack.
 
 
 For more information and a full list of configurable attributes of the Slack 
-alerter, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.slack.alerters.slack_alerter.SlackAlerter).
+alerter, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-slack/#zenml.integrations.slack.alerters.slack_alerter.SlackAlerter).
diff --git a/docs/book/component-gallery/artifact-stores/amazon-s3.md b/docs/book/component-gallery/artifact-stores/amazon-s3.md
@@ -208,7 +208,7 @@ zenml artifact-store register minio_store -f s3 \
 ```
 
 For more, up-to-date information on the S3 Artifact Store implementation and its
-configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.s3.artifact_stores.s3_artifact_store).
+configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-s3/#zenml.integrations.s3.artifact_stores.s3_artifact_store).
 
 ## How do you use it?
 

diff --git a/docs/book/component-gallery/artifact-stores/artifact-stores.md b/docs/book/component-gallery/artifact-stores/artifact-stores.md
@@ -131,9 +131,9 @@ Python modules:
 * `zenml.io.fileio` provides low-level utilities for manipulating Artifact Store
 objects (e.g. `open`, `copy`, `rename`, `remove`, `mkdir`). These functions
 work seamlessly across Artifact Stores types. They have the same signature as
-the [Artifact Store abstraction methods](https://apidocs.zenml.io/latest/api_docs/artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore)
+the [Artifact Store abstraction methods](https://apidocs.zenml.io/latest/core_code_docs/core-artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore)
 (in fact, they are one and the same under the hood).
-* [zenml.utils.io_utils](https://apidocs.zenml.io/latest/api_docs/utils/#zenml.utils.io_utils)
+* [zenml.utils.io_utils](https://apidocs.zenml.io/latest/core_code_docs/core-utils/#zenml.utils.io_utils)
 includes some higher-level helper utilities that make it easier to find and
 transfer objects between the Artifact Store and the local filesystem or memory.
 

diff --git a/docs/book/component-gallery/artifact-stores/azure-blob-storage.md b/docs/book/component-gallery/artifact-stores/azure-blob-storage.md
@@ -182,7 +182,7 @@ zenml secrets-manager secret register az_secret -s azure \
 {% endtabs %}
 
 For more, up-to-date information on the Azure Artifact Store implementation and
-its configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.azure.artifact_stores).
+its configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-azure/#zenml.integrations.azure.artifact_stores).
 
 ## How do you use it?
 

diff --git a/docs/book/component-gallery/artifact-stores/custom.md b/docs/book/component-gallery/artifact-stores/custom.md
@@ -13,7 +13,7 @@ implementation.
 
 The Artifact Store establishes one of the main components in every ZenML stack.
 Now, let us take a deeper dive into the fundamentals behind its abstraction,
-namely [the `BaseArtifactStore` class](https://apidocs.zenml.io/latest/api_docs/artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore):
+namely [the `BaseArtifactStore` class](https://apidocs.zenml.io/latest/core_code_docs/core-artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore):
 
 1. As ZenML only supports filesystem-based artifact stores, it features a 
 configuration parameter called `path`, which will indicate the root path of 
@@ -142,7 +142,7 @@ class BaseArtifactStoreFlavor(Flavor):
 {% hint style="info" %}
 This is a slimmed-down version of the base implementation which aims to 
 highlight the abstraction layer. In order to see the full implementation 
-and get the complete docstrings, please check the [API docs](https://apidocs.zenml.io/latest/api_docs/artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore).
+and get the complete docstrings, please check the [API docs](https://apidocs.zenml.io/latest/core_code_docs/core-artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore).
 {% endhint %}
 
 #### The effect on the `zenml.io.fileio`
@@ -161,7 +161,7 @@ that you defined within your artifact store.
 If you want to implement your own custom Artifact Store, you can 
 follow the following steps:
 
-1. Create a class which inherits from [the `BaseArtifactStore` class](https://apidocs.zenml.io/latest/api_docs/artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore)
+1. Create a class which inherits from [the `BaseArtifactStore` class](https://apidocs.zenml.io/latest/core_code_docs/core-artifact_stores/#zenml.artifact_stores.base_artifact_store.BaseArtifactStore)
 and implement the abstract methods.
 2. Create a class which inherits from [the `BaseArtifactStoreConfig` class]() 
 and fill in the `SUPPORTED_SCHEMES` based on your file system.

diff --git a/docs/book/component-gallery/artifact-stores/gcloud-gcs.md b/docs/book/component-gallery/artifact-stores/gcloud-gcs.md
@@ -155,7 +155,7 @@ zenml secrets-manager secret register gcp_secret -s gcp \
 {% endtabs %}
 
 For more, up-to-date information on the GCS Artifact Store implementation and its
-configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.gcp.artifact_stores.gcp_artifact_store).
+configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-gcp/#zenml.integrations.gcp.artifact_stores.gcp_artifact_store).
 
 ## How do you use it?
 

diff --git a/docs/book/component-gallery/artifact-stores/local.md b/docs/book/component-gallery/artifact-stores/local.md
@@ -101,7 +101,7 @@ to be able to access the local Artifact Store.
 {% endhint %}
 
 For more, up-to-date information on the local Artifact Store implementation and
-its configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/api_docs/artifact_stores/#zenml.artifact_stores.local_artifact_store). 
+its configuration, you can have a look at [the API docs](https://apidocs.zenml.io/latest/core_code_docs/core-artifact_stores/#zenml.artifact_stores.local_artifact_store). 
 
 ## How do you use it?
 

diff --git a/docs/book/component-gallery/container-registries/amazon-ecr.md b/docs/book/component-gallery/container-registries/amazon-ecr.md
@@ -77,4 +77,4 @@ aws ecr get-login-password --region <REGION> | docker login --username AWS --pas
 ```
 
 For more information and a full list of configurable attributes of the AWS 
-container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.aws.container_registries.aws_container_registry.AWSContainerRegistry).
+container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-aws/#zenml.integrations.aws.container_registries.aws_container_registry.AWSContainerRegistry).
diff --git a/docs/book/component-gallery/container-registries/azure.md b/docs/book/component-gallery/container-registries/azure.md
@@ -65,4 +65,4 @@ az acr login --name=<REGISTRY_NAME>
 ```
 
 For more information and a full list of configurable attributes of the Azure 
-container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/container_registries/#zenml.container_registries.azure_container_registry.AzureContainerRegistry).
+container registry, check out the [API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-container_registries/#zenml.container_registries.azure_container_registry.AzureContainerRegistry).
diff --git a/docs/book/component-gallery/container-registries/custom.md b/docs/book/component-gallery/container-registries/custom.md
@@ -72,7 +72,7 @@ class BaseContainerRegistryFlavor(Flavor):
 {% hint style="info" %}
 This is a slimmed-down version of the base implementation which aims to 
 highlight the abstraction layer. In order to see the full implementation 
-and get the complete docstrings, please check the [API docs](https://apidocs.zenml.io/latest/api_docs/container_registries/#zenml.container_registries.base_container_registry.BaseContainerRegistry).
+and get the complete docstrings, please check the [API docs](https://apidocs.zenml.io/latest/core_code_docs/core-container_registries/#zenml.container_registries.base_container_registry.BaseContainerRegistry).
 {% endhint %}
 
 ## Building your own container registry

diff --git a/docs/book/component-gallery/container-registries/default.md b/docs/book/component-gallery/container-registries/default.md
@@ -42,4 +42,4 @@ zenml stack update -c <NAME>
 ```
 
 For more information and a full list of configurable attributes of the Default 
-container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/integrations/#zenml.integrations.aws.container_registries.default_container_registry.DefaultContainerRegistry).
+container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/integration_code_docs/integrations-aws/#zenml.integrations.aws.container_registries.default_container_registry.DefaultContainerRegistry).
diff --git a/docs/book/component-gallery/container-registries/dockerhub.md b/docs/book/component-gallery/container-registries/dockerhub.md
@@ -75,4 +75,4 @@ docker login
 ```
 
 For more information and a full list of configurable attributes of the dockerhub
-container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/container_registries/#zenml.container_registries.dockerhub_container_registry.DockerHubContainerRegistry).
+container registry, check out the [API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-container_registries/#zenml.container_registries.dockerhub_container_registry.DockerHubContainerRegistry).
diff --git a/docs/book/component-gallery/container-registries/gcloud.md b/docs/book/component-gallery/container-registries/gcloud.md
@@ -130,4 +130,4 @@ gcloud auth configure-docker <REGION>-docker.pkg.dev
 
 
 For more information and a full list of configurable attributes of the GCP 
-container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/container_registries/#zenml.container_registries.gcp_container_registry.GCPContainerRegistry).
+container registry, check out the [API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-container_registries/#zenml.container_registries.gcp_container_registry.GCPContainerRegistry).
diff --git a/docs/book/component-gallery/container-registries/github.md b/docs/book/component-gallery/container-registries/github.md
@@ -55,7 +55,7 @@ zenml stack update -c <NAME>
 ```
 
 For more information and a full list of configurable attributes of the GitHub 
-container registry, check out the [API Docs](https://apidocs.zenml.io/latest/api_docs/container_registries/#zenml.container_registries.github_container_registry.GitHubContainerRegistry).
+container registry, check out the [API Docs](https://apidocs.zenml.io/latest/core_code_docs/core-container_registries/#zenml.container_registries.github_container_registry.GitHubContainerRegistry).
 
 
 

diff --git a/docs/book/component-gallery/data-validators/custom.md b/docs/book/component-gallery/data-validators/custom.md
@@ -27,7 +27,7 @@ If you want to implement your own custom Data Validator, you can follow the
 following steps:
 
 
-1. Create a class which inherits from [the `BaseDataValidator` class](https://apidocs.zenml.io/latest/api_docs/data_validators/#zenml.data_validators.base_data_validator.BaseDataValidator)
+1. Create a class which inherits from [the `BaseDataValidator` class](https://apidocs.zenml.io/latest/core_code_docs/core-data_validators/#zenml.data_validators.base_data_validator.BaseDataValidator)
 and override one or more of the abstract methods, depending on the
 capabilities of the underlying library/service that you want to integrate.
 2. If you need any configuration, you can create a class which inherits