From 3ecd0720d881ac0f0506934f3d56d94a22e75233 Mon Sep 17 00:00:00 2001 From: YolanFery Date: Tue, 6 Oct 2026 17:32:40 +0200 Subject: [PATCH] fix: documentation link --- README.md | 8 ++++---- openhexa/cli/cli.py | 2 +- openhexa/sdk/datasets/__init__.py | 4 ++-- openhexa/sdk/datasets/dataset.py | 6 +++--- openhexa/sdk/files/__init__.py | 2 +- openhexa/sdk/files/file.py | 4 ++-- openhexa/sdk/pipelines/__init__.py | 4 ++-- openhexa/sdk/pipelines/parameter/__init__.py | 2 +- openhexa/sdk/pipelines/pipeline.py | 4 ++-- openhexa/sdk/pipelines/task.py | 4 ++-- openhexa/sdk/workspaces/__init__.py | 2 +- openhexa/sdk/workspaces/current_workspace.py | 2 +- 12 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 59907ca6..743330a3 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,13 @@ OpenHEXA is an open-source data integration platform developed by [Bluesquare](h Its goal is to facilitate data integration and analysis workflows, in particular in the context of public health projects. -Please refer to the [OpenHEXA wiki](https://github.com/BLSQ/openhexa/wiki/Home) for more information about OpenHEXA. +Please refer to the [OpenHEXA documentation](https://docs.openhexa.com/) for more information about OpenHEXA. This repository contains the code of the OpenHEXA SDK, a library allows you to write code for the OpenHEXA platform. It is particularly useful to write OpenHEXA data pipelines, but can also be used in the OpenHEXA notebooks environment. -The OpenHEXA wiki has a section dedicated to the SDK: -[Using the OpenHEXA SDK](https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK). +The OpenHEXA documentation has a section dedicated to the SDK: +[Using the OpenHEXA SDK](https://docs.openhexa.com/sdk/). Requirements ------------ @@ -116,7 +116,7 @@ pip install -e ".[dev]" # Necessary to be able to run the openhexa CLI While it is possible to run pipelines locally using only the SDK, if you want to run OpenHEXA in a more realistic setting you will need to install the OpenHEXA app and frontend components. Please refer to the -[installation instructions](https://github.com/BLSQ/openhexa/wiki/Installation-instructions) for more information. +[installation instructions](https://docs.openhexa.com/installation/) for more information. You can then configure the OpenHEXA CLI to connect to your local backend: diff --git a/openhexa/cli/cli.py b/openhexa/cli/cli.py index 2648e21b..5ad0e3c4 100644 --- a/openhexa/cli/cli.py +++ b/openhexa/cli/cli.py @@ -628,7 +628,7 @@ def pipelines_run( click.secho("Open your pipeline directory with VSCode and start the debugging session") click.secho( - "Visit the wiki for more information: https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#debugging-and-troubleshooting-your-pipelines", + "Visit the documentation for more information: https://docs.openhexa.com/writing-pipelines/#debugging-and-troubleshooting-your-pipelines", fg="blue", ) diff --git a/openhexa/sdk/datasets/__init__.py b/openhexa/sdk/datasets/__init__.py index 20efeca7..8d18d5fb 100644 --- a/openhexa/sdk/datasets/__init__.py +++ b/openhexa/sdk/datasets/__init__.py @@ -1,7 +1,7 @@ """Datasets package. -See https://github.com/BLSQ/openhexa/wiki/User-manual#datasets and -https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK#working-with-datasets for more information about OpenHEXA +See https://docs.openhexa.com/datasets/ and +https://docs.openhexa.com/sdk/#working-with-datasets for more information about OpenHEXA dataset. """ diff --git a/openhexa/sdk/datasets/dataset.py b/openhexa/sdk/datasets/dataset.py index f2d01bf4..9a0fa1b6 100644 --- a/openhexa/sdk/datasets/dataset.py +++ b/openhexa/sdk/datasets/dataset.py @@ -1,7 +1,7 @@ """Dataset-related classes and functions. -See https://github.com/BLSQ/openhexa/wiki/User-manual#datasets and -https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK#working-with-datasets for more information about datasets. +See https://docs.openhexa.com/datasets/ and +https://docs.openhexa.com/sdk/#working-with-datasets for more information about datasets. """ import base64 @@ -425,7 +425,7 @@ def raise_dataset_file_creation_exception(self, errors): class Dataset: """Datasets are versioned, documented files. - See https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK#working-with-datasets for more information. + See https://docs.openhexa.com/sdk/#working-with-datasets for more information. """ _latest_version = None diff --git a/openhexa/sdk/files/__init__.py b/openhexa/sdk/files/__init__.py index 0554b305..a7b76b70 100644 --- a/openhexa/sdk/files/__init__.py +++ b/openhexa/sdk/files/__init__.py @@ -1,6 +1,6 @@ """Files package. -See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#using-file-parameters +See https://docs.openhexa.com/writing-pipelines/#using-file-parameters """ from .file import File diff --git a/openhexa/sdk/files/file.py b/openhexa/sdk/files/file.py index 90ab3e8b..4deabe56 100644 --- a/openhexa/sdk/files/file.py +++ b/openhexa/sdk/files/file.py @@ -1,13 +1,13 @@ """File-related classes and functions. -See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#using-file-parameters +See https://docs.openhexa.com/writing-pipelines/#using-file-parameters """ class File: """File class. - See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#using-file-parameters + See https://docs.openhexa.com/writing-pipelines/#using-file-parameters """ def __init__( diff --git a/openhexa/sdk/pipelines/__init__.py b/openhexa/sdk/pipelines/__init__.py index 55de75f5..5745545f 100644 --- a/openhexa/sdk/pipelines/__init__.py +++ b/openhexa/sdk/pipelines/__init__.py @@ -1,7 +1,7 @@ """Pipelines package. -See https://github.com/BLSQ/openhexa/wiki/User-manual#using-pipelines and -https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines for more information about OpenHEXA pipelines. +See https://docs.openhexa.com/pipelines/ and +https://docs.openhexa.com/writing-pipelines/ for more information about OpenHEXA pipelines. """ from .parameter import parameter diff --git a/openhexa/sdk/pipelines/parameter/__init__.py b/openhexa/sdk/pipelines/parameter/__init__.py index 774fd1ec..824562ec 100644 --- a/openhexa/sdk/pipelines/parameter/__init__.py +++ b/openhexa/sdk/pipelines/parameter/__init__.py @@ -1,6 +1,6 @@ """Pipeline parameters classes and functions. -See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#pipeline-parameters for more information. +See https://docs.openhexa.com/writing-pipelines/#pipeline-parameters for more information. """ from openhexa.sdk.pipelines.exceptions import InvalidParameterError, ParameterValueError diff --git a/openhexa/sdk/pipelines/pipeline.py b/openhexa/sdk/pipelines/pipeline.py index f3f7b537..34795053 100644 --- a/openhexa/sdk/pipelines/pipeline.py +++ b/openhexa/sdk/pipelines/pipeline.py @@ -1,7 +1,7 @@ """Main pipeline module containing the building blocks for OpenHEXA pipelines. -See https://github.com/BLSQ/openhexa/wiki/User-manual#using-pipelines and -https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines for more information about OpenHEXA pipelines. +See https://docs.openhexa.com/pipelines/ and +https://docs.openhexa.com/writing-pipelines/ for more information about OpenHEXA pipelines. """ import argparse diff --git a/openhexa/sdk/pipelines/task.py b/openhexa/sdk/pipelines/task.py index 3a6da086..dcd72e7a 100644 --- a/openhexa/sdk/pipelines/task.py +++ b/openhexa/sdk/pipelines/task.py @@ -1,6 +1,6 @@ """Classes and functions related to pipeline tasks. -See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#pipelines-and-tasks for more information. +See https://docs.openhexa.com/writing-pipelines/#pipelines-and-tasks for more information. """ from __future__ import annotations @@ -26,7 +26,7 @@ def __init__(self, task): class Task: """Tasks are pipeline data processing code units. - See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#pipelines-and-tasks for more information. + See https://docs.openhexa.com/writing-pipelines/#pipelines-and-tasks for more information. """ def __init__(self, function: typing.Callable): diff --git a/openhexa/sdk/workspaces/__init__.py b/openhexa/sdk/workspaces/__init__.py index 033200b2..3f6063ef 100644 --- a/openhexa/sdk/workspaces/__init__.py +++ b/openhexa/sdk/workspaces/__init__.py @@ -1,6 +1,6 @@ """Workspaces package. -See https://github.com/BLSQ/openhexa/wiki/User-manual#about-workspaces for more information about OpenHEXA workspaces. +See https://docs.openhexa.com/workspaces/ for more information about OpenHEXA workspaces. """ from .current_workspace import CurrentWorkspace diff --git a/openhexa/sdk/workspaces/current_workspace.py b/openhexa/sdk/workspaces/current_workspace.py index c53d653a..3137e0c0 100644 --- a/openhexa/sdk/workspaces/current_workspace.py +++ b/openhexa/sdk/workspaces/current_workspace.py @@ -1,6 +1,6 @@ """Workspace-related classes and functions. -See https://github.com/BLSQ/openhexa/wiki/User-manual#about-workspaces for more information. +See https://docs.openhexa.com/workspaces/ for more information. """ import os