Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs_link to manifest #16

Merged
merged 2 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Do not edit - changes here will be overwritten by Copier
_commit: v0.4.2
_commit: v0.4.4
_src_path: gh:fractal-analytics-platform/fractal-tasks-template
author_email: [email protected]
author_name: Joel Luethi
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/build_and_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@ name: CI (build and test)

on:
push:
branches: ["main"]
branches:
- main
tags:
- "*"
pull_request:
branches: ["main"]
workflow_dispatch:
release:
types: [published]


jobs:
Expand Down
6 changes: 4 additions & 2 deletions src/fractal_helper_tasks/__FRACTAL_MANIFEST__.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
"type": "object",
"title": "DropTDimension"
},
"docs_info": "## drop_t_dimension\nDrops singleton t dimension.\n"
"docs_info": "## drop_t_dimension\nDrops singleton t dimension.\n",
"docs_link": "https://github.com/jluethi/fractal-helper-tasks"
},
{
"name": "Convert 2D segmentation to 3D",
Expand Down Expand Up @@ -125,7 +126,8 @@
"type": "object",
"title": "Convert2dSegmentationTo3d"
},
"docs_info": "## convert_2D_segmentation_to_3D\nConvert 2D segmentation to 3D segmentation.\n\nThis task loads the 2D segmentation, replicates it along the Z slice and\nstores it back into the 3D OME-Zarr image.\n\nThis is a temporary workaround task, as long as we store 2D data in\na separate OME-Zarr file from the 3D data. If the 2D & 3D OME-Zarr images\nhave different suffixes in their name, use `image_suffix_2D_to_remove` &\n`image_suffix_3D_to_add`. If their base names are different, this task\ndoes not support processing them at the moment.\n\nIt makes the assumption that the 3D OME-Zarrs are stored in the same place\nas the 2D OME-Zarrs (same based folder).\n"
"docs_info": "## convert_2D_segmentation_to_3D\nConvert 2D segmentation to 3D segmentation.\n\nThis task loads the 2D segmentation, replicates it along the Z slice and\nstores it back into the 3D OME-Zarr image.\n\nThis is a temporary workaround task, as long as we store 2D data in\na separate OME-Zarr file from the 3D data. If the 2D & 3D OME-Zarr images\nhave different suffixes in their name, use `image_suffix_2D_to_remove` &\n`image_suffix_3D_to_add`. If their base names are different, this task\ndoes not support processing them at the moment.\n\nIt makes the assumption that the 3D OME-Zarrs are stored in the same place\nas the 2D OME-Zarrs (same based folder).\n",
"docs_link": "https://github.com/jluethi/fractal-helper-tasks"
}
],
"has_args_schemas": true,
Expand Down
6 changes: 5 additions & 1 deletion src/fractal_helper_tasks/dev/create_manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,8 @@
"""
PACKAGE = "fractal_helper_tasks"
AUTHORS = "Joel Luethi"
create_manifest(package=PACKAGE, authors=AUTHORS)
docs_link = "https://github.com/jluethi/fractal-helper-tasks"
if docs_link:
create_manifest(package=PACKAGE, authors=AUTHORS, docs_link=docs_link)
else:
create_manifest(package=PACKAGE, authors=AUTHORS)