chore: Add linkcheck to github actions. Fix broken external links. (#2657)

Author: MortGron

.github/workflows/build.yml

@@ -35,8 +35,12 @@ jobs:
     steps:
       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
       - uses: ./.github/actions/setup
+      - name: Run docs linkcheck
+        working-directory: ./docs
+        run: make linkcheck SPHINXOPTS="-W"
       - name: Build docs
-        run: cd docs && make html SPHINXOPTS="-W --keep-going"
+        working-directory: ./docs
+        run: make html SPHINXOPTS="-W"
 
   build_package:
     runs-on: ubuntu-latest

cognite/client/_api/ai/tools/documents.py

@@ -78,7 +78,7 @@ async def ask_question(
         additional_context: str | None = None,
         ignore_unknown_ids: bool = False,
     ) -> Answer:
-        """`Ask a question about one or more documents using a Large Language Model <https://api-docs.cognite.com/20230101/tag/Document-AI/operation/documents_summary_api_v1_projects__projectName__ai_tools_documents_summarize_post>`_.
+        """`Ask a question about one or more documents using a Large Language Model <https://api-docs.cognite.com/20230101/tag/Document-AI/operation/document_questioning_ai_tools_documents_ask_post>`_.
 
         Supports up to 100 documents at a time.
 

cognite/client/_api/data_modeling/instances.py

@@ -771,7 +771,7 @@ async def inspect(
         involved_views: InvolvedViews | None = None,
         involved_containers: InvolvedContainers | None = None,
     ) -> InstanceInspectResults:
-        """`Reverse lookup for instances <https://developer.cognite.com/api/v1/#tag/Instances/operation/instanceInspect>`_.
+        """`Reverse lookup for instances <https://api-docs.cognite.com/20230101/tag/Instances/operation/instanceInspect>`_.
 
         This method will return the involved views and containers for the given nodes and edges.
 
@@ -1213,7 +1213,7 @@ async def search(
         sort: Sequence[InstanceSort | dict] | InstanceSort | dict | None = None,
         operator: Literal["AND", "OR"] = "AND",
     ) -> NodeList[T_Node] | EdgeList[T_Edge]:
-        """`Search instances <https://developer.cognite.com/api/v1/#tag/Instances/operation/searchInstances>`_.
+        """`Search instances <https://api-docs.cognite.com/20230101/tag/Instances/operation/searchInstances>`_.
 
         Args:
             view (ViewId): View to search in.
@@ -1376,7 +1376,7 @@ async def aggregate(
         filter: Filter | dict[str, Any] | None = None,
         limit: int | None = DEFAULT_LIMIT_READ,
     ) -> AggregatedNumberedValue | list[AggregatedNumberedValue] | InstanceAggregationResultList:
-        """`Aggregate data across nodes/edges <https://developer.cognite.com/api/v1/#tag/Instances/operation/aggregateInstances>`_.
+        """`Aggregate data across nodes/edges <https://api-docs.cognite.com/20230101/tag/Instances/operation/aggregateInstances>`_.
 
         Args:
             view (ViewId): View to aggregate over.
@@ -1489,7 +1489,7 @@ async def histogram(
         filter: Filter | dict[str, Any] | None = None,
         limit: int = DEFAULT_LIMIT_READ,
     ) -> HistogramValue | list[HistogramValue]:
-        """`Produces histograms for nodes/edges <https://developer.cognite.com/api/v1/#tag/Instances/operation/aggregateInstances>`_.
+        """`Produces histograms for nodes/edges <https://api-docs.cognite.com/20230101/tag/Instances/operation/aggregateInstances>`_.
 
         Args:
             view (ViewId): View to to aggregate over.
@@ -1558,7 +1558,7 @@ async def histogram(
     async def query(
         self, query: Query, include_typing: bool = False, debug: DebugParameters | None = None
     ) -> QueryResult:
-        """`Advanced query interface for nodes/edges <https://developer.cognite.com/api/v1/#tag/Instances/operation/queryContent>`_.
+        """`Advanced query interface for nodes/edges <https://api-docs.cognite.com/20230101/tag/Instances/operation/queryContent>`_.
 
         The Data Modelling API exposes an advanced query interface. The query interface supports parameterization,
         recursive edge traversal, chaining of result sets, and granular property selection.
@@ -1652,7 +1652,7 @@ async def query(
     async def sync(
         self, query: QuerySync, include_typing: bool = False, debug: DebugParameters | None = None
     ) -> QueryResult:
-        """`Subscription to changes for nodes/edges <https://developer.cognite.com/api/v1/#tag/Instances/operation/syncContent>`_.
+        """`Subscription to changes for nodes/edges <https://api-docs.cognite.com/20230101/tag/Instances/operation/syncContent>`_.
 
         Subscribe to changes for nodes and edges in a project, matching a supplied filter.
 

cognite/client/_api/functions/__init__.py

@@ -201,8 +201,8 @@ async def create(
             memory (float | None): Memory per function measured in GB. Allowed range and default value are given by the `limits endpoint. <https://api-docs.cognite.com/20230101/tag/Functions/operation/functionsLimits>`_, and None translates to the API default. On Azure, only the default value is used.
             runtime (RunTime | None): The function runtime. Valid values are ["py310", "py311", "py312", "py313", `None`], and `None` translates to the API default which will change over time. The runtime "py313" resolves to the latest version of the Python 3.13 series.
             metadata (dict[str, str] | None): Metadata for the function as key/value pairs. Key & values can be at most 32, 512 characters long respectively. You can have at the most 16 key-value pairs, with a maximum size of 512 bytes.
-            index_url (str | None): Index URL for Python Package Manager to use. Be aware of the intrinsic security implications of using the `index_url` option. `More information can be found on official docs, <https://docs.cognite.com/cdf/functions/#additional-arguments>`_
-            extra_index_urls (list[str] | None): Extra Index URLs for Python Package Manager to use. Be aware of the intrinsic security implications of using the `extra_index_urls` option. `More information can be found on official docs, <https://docs.cognite.com/cdf/functions/#additional-arguments>`_
+            index_url (str | None): Index URL for Python Package Manager to use. Be aware of the intrinsic security implications of using the `index_url` option. `More information can be found on official docs, <https://docs.cognite.com/cdf/functions/use_functions#additional-arguments>`_
+            extra_index_urls (list[str] | None): Extra Index URLs for Python Package Manager to use. Be aware of the intrinsic security implications of using the `extra_index_urls` option. `More information can be found on official docs, <https://docs.cognite.com/cdf/functions/use_functions#additional-arguments>`_
             skip_folder_validation (bool): When creating a function using the 'folder' argument, pass True to skip the extra validation step that attempts to import the module. Skipping can be useful when your function requires several heavy packages to already be installed locally. Defaults to False.
             data_set_id (int | None): Data set to upload the function code to. Note: Does not affect the function itself.
 

cognite/client/_api/simulators/models_revisions.py

@@ -279,7 +279,7 @@ async def create(
         )
 
     async def retrieve_data(self, model_revision_external_id: str) -> SimulatorModelRevisionDataList:
-        """`Filter simulator model revision data <https://api-docs.cognite.com/20230101-alpha/tag/Simulator-Models/operation/get_simulator_model_revision_data_by_id>`_
+        """`Filter simulator model revision data <https://api-docs.cognite.com/20230101-alpha/tag/Simulator-Models/operation/retrieve_simulator_model_revision_data>`_
 
         Retrieves a list of simulator model revisions data that match the given criteria.
 

cognite/client/_api/simulators/runs.py

@@ -307,7 +307,7 @@ async def list_run_data(
         self,
         run_id: int,
     ) -> SimulationRunDataList:
-        """`Get simulation run data <https://api-docs.cognite.com/20230101/tag/Simulation-Runs/operation/simulation_data_by_run_id_simulators_runs_data_list_post>`_
+        """`Get simulation run data <https://api-docs.cognite.com/20230101/tag/Simulation-Runs/operation/retrieve_simulation_run_data>`_
 
         Retrieve data associated with a simulation run by ID.
 

cognite/client/_api/synthetic_time_series.py

@@ -101,7 +101,7 @@ async def query(
         """`Calculate the result of a function on time series <https://api-docs.cognite.com/20230101/tag/Synthetic-Time-Series/operation/querySyntheticTimeseries>`_.
 
         Info:
-            You can read the guide to synthetic time series in our `documentation <https://docs.cognite.com/dev/concepts/resource_types/synthetic_timeseries>`_.
+            You can read the guide to synthetic time series in our `documentation <https://docs.cognite.com/api-reference/concepts/20230101/synthetic-time-series>`_.
 
         Args:
             expressions (str | sympy.Basic | Sequence[str] | Sequence[sympy.Basic]): Functions to be calculated. Supports both strings and sympy expressions. Strings can have either the API `ts{}` syntax, or contain variable names to be replaced using the `variables` parameter.

cognite/client/_api/workflows/versions.py

@@ -92,7 +92,7 @@ async def upsert(self, version: Sequence[WorkflowVersionUpsert]) -> WorkflowVers
     async def upsert(
         self, version: WorkflowVersionUpsert | Sequence[WorkflowVersionUpsert], mode: Literal["replace"] = "replace"
     ) -> WorkflowVersion | WorkflowVersionList:
-        """`Create one or more workflow version(s) <https://api-docs.cognite.com/20230101/tag/Workflows/operation/CreateOrUpdateWorkflowVersion>`_.
+        """`Create one or more workflow version(s) <https://api-docs.cognite.com/20230101/tag/Workflow-versions/operation/CreateOrUpdateWorkflowVersion/>`_.
 
         Note this is an upsert endpoint, so workflow versions that already exist will be updated, and new ones will be created.
 

cognite/client/_cognite_client.py

@@ -260,7 +260,7 @@ def default(
 
         The default configuration creates the URLs based on the project and cluster:
 
-        * Base URL: "https://{cdf_cluster}.cognitedata.com/
+        * Base URL: ``"https://{cdf_cluster}.cognitedata.com/"``
 
         Args:
             project (str): The CDF project.
@@ -288,9 +288,9 @@ def default_oauth_client_credentials(
 
         The default configuration creates the URLs based on the project and cluster:
 
-        * Base URL: "https://{cdf_cluster}.cognitedata.com/
-        * Token URL: "https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/token"
-        * Scopes: [f"https://{cdf_cluster}.cognitedata.com/.default"]
+        * Base URL: ``"https://{cdf_cluster}.cognitedata.com/"``
+        * Token URL: ``"https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/token"``
+        * Scopes: ``[f"https://{cdf_cluster}.cognitedata.com/.default"]``
 
         Args:
             project (str): The CDF project.
@@ -320,9 +320,9 @@ def default_oauth_interactive(
 
         The default configuration creates the URLs based on the tenant_id and cluster:
 
-        * Base URL: "https://{cdf_cluster}.cognitedata.com/
-        * Authority URL: "https://login.microsoftonline.com/{tenant_id}"
-        * Scopes: [f"https://{cdf_cluster}.cognitedata.com/.default"]
+        * Base URL: ``"https://{cdf_cluster}.cognitedata.com/"``
+        * Authority URL: ``"https://login.microsoftonline.com/{tenant_id}"``
+        * Scopes: ``[f"https://{cdf_cluster}.cognitedata.com/.default"]``
 
         Args:
             project (str): The CDF project.