Merge pull request #118 from siapy/develop

Develop
siapy · Aug 20, 2024 · 72e1d5b · 72e1d5b
2 parents ec24722 + 5e5383d
commit 72e1d5b
Show file tree

Hide file tree

Showing 28 changed files with 66 additions and 44 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,10 +1,12 @@
 name: Deploy MkDocs
 
 on:
-  workflow_run:
-    workflows: ["Publish To PyPI"]
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
     types:
-      - completed
+      - closed
 
 permissions:
   contents: write

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -19,10 +19,9 @@ jobs:
         id: check_title
         run: |
           if [[ "${{ github.event.pull_request.title }}" == "chore(main): release"* ]]; then
-            echo "::set-output name=is_chore_main_release::true"
+            echo "is_chore_main_release=true" >> $GITHUB_OUTPUT
           else
-            echo "::set-output name=is_chore_main_release::false"
-          fi
+            echo "is_chore_main_release=false" >> $GITHUB_OUTPUT
 
   pypi-publish:
     needs: check-pr-title

diff --git a/docs/api/core/configs.md b/docs/api/core/configs.md
@@ -0,0 +1,2 @@
+
+::: siapy.core.configs
diff --git a/docs/api/core/logger.md b/docs/api/core/logger.md
@@ -0,0 +1 @@
+::: siapy.core.logger
diff --git a/docs/api/core/types.md b/docs/api/core/types.md
@@ -0,0 +1,2 @@
+
+::: siapy.core.types
diff --git a/docs/api/datasets/helpers.md b/docs/api/datasets/helpers.md
@@ -0,0 +1 @@
+::: siapy.datasets.helpers
diff --git a/docs/api/datasets/schemas.md b/docs/api/datasets/schemas.md
@@ -0,0 +1 @@
+::: siapy.datasets.schemas
diff --git a/docs/api/datasets/tabular.md b/docs/api/datasets/tabular.md
@@ -0,0 +1 @@
+::: siapy.datasets.tabular
diff --git a/docs/api/entities/images.md b/docs/api/entities/images.md
@@ -0,0 +1,2 @@
+
+::: siapy.entities.images
diff --git a/docs/api/entities/imagesets.md b/docs/api/entities/imagesets.md
@@ -0,0 +1 @@
+::: siapy.entities.imagesets
diff --git a/docs/api/entities/pixels.md b/docs/api/entities/pixels.md
@@ -0,0 +1 @@
+::: siapy.entities.pixels
diff --git a/docs/api/entity.md → docs/api/entities/shapes.md b/docs/api/entity.md → docs/api/entities/shapes.md
diff --git a/docs/api/entities/signatures.md b/docs/api/entities/signatures.md
@@ -0,0 +1 @@
+::: siapy.entities.signatures
diff --git a/docs/api/features/features.md b/docs/api/features/features.md
@@ -0,0 +1 @@
+::: siapy.features.features
diff --git a/docs/api/features/helpers.md b/docs/api/features/helpers.md
@@ -0,0 +1 @@
+::: siapy.features.helpers
diff --git a/docs/api/features/spectral_indices.md b/docs/api/features/spectral_indices.md
@@ -0,0 +1 @@
+::: siapy.features.spectral_indices
diff --git a/docs/api/models/metrics.md b/docs/api/models/metrics.md
@@ -0,0 +1 @@
+::: siapy.models.metrics
diff --git a/docs/api/optimizers/configs.md b/docs/api/optimizers/configs.md
@@ -0,0 +1 @@
+::: siapy.optimizers.configs
diff --git a/docs/api/optimizers/optimizers.md b/docs/api/optimizers/optimizers.md
@@ -0,0 +1 @@
+::: siapy.optimizers.optimizers
diff --git a/docs/api/optimizers/parameters.md b/docs/api/optimizers/parameters.md
@@ -0,0 +1 @@
+::: siapy.optimizers.parameters
diff --git a/docs/api/optimizers/scorers.md b/docs/api/optimizers/scorers.md
@@ -0,0 +1 @@
+::: siapy.optimizers.scorers
diff --git a/docs/api/transformations/corregistrator.md b/docs/api/transformations/corregistrator.md
@@ -0,0 +1 @@
+::: siapy.transformations.corregistrator
diff --git a/docs/api/transformations/image.md b/docs/api/transformations/image.md
@@ -0,0 +1 @@
+::: siapy.transformations.image
diff --git a/docs/api/utils/evaluators.md b/docs/api/utils/evaluators.md
@@ -0,0 +1 @@
+::: siapy.utils.evaluators
diff --git a/docs/api/utils/images.md b/docs/api/utils/images.md
@@ -0,0 +1 @@
+::: siapy.utils.images
diff --git a/docs/api/utils/plots.md b/docs/api/utils/plots.md
@@ -0,0 +1 @@
+::: siapy.utils.plots
diff --git a/docs/index.md b/docs/index.md
@@ -1,35 +1 @@
-
-<p align="center">
-  <img src="https://github.com/siapy/siapy-lib/blob/main/docs/images/logo.png?raw=true" alt="Sublime's custom image" width="300"/>
-</p>
-
-<p align="center">
-    <em>Spectral imaging analysis for Python (SiaPy) is a tool for efficient processing of spectral images</em>
-</p>
-<p align="center">
-<a href="https://github.com/siapy/siapy-lib/actions?query=workflow%3ATest+event%3Apull_request+branch%3Amain" target="_blank">
-    <img src="https://github.com/siapy/siapy-lib/actions/workflows/test.yml/badge.svg?branch=main" alt="Test">
-</a>
-<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/siapy/siapy-lib" target="_blank">
-    <img src="https://coverage-badge.samuelcolvin.workers.dev/siapy/siapy-lib.svg" alt="Coverage">
-</a>
-<a href="https://pypi.org/project/siapy" target="_blank">
-    <img src="https://img.shields.io/pypi/v/siapy?color=%2334D058&label=pypi%20package" alt="Package version">
-</a>
-<a href="https://zenodo.org/doi/10.5281/zenodo.7409193"><img src="https://zenodo.org/badge/491829141.svg" alt="DOI"></a>
-<a href="https://pypi.org/project/siapy" target="_blank">
-    <img src="https://img.shields.io/pypi/pyversions/siapy.svg?color=%2334D058" alt="Supported Python versions">
-</a>
-</p>
-
----
-
-__Source Code__: <https://github.com/siapy/siapy-lib>
-
-__Bug Report / Feature Request__: <https://github.com/siapy/siapy-lib/issues/new/choose>
-
-<!-- **Tutorials**: <a href="https://github.com/Agricultural-institute/SiaPy/tree/master/tutorials" target="_blank">https://github.com/Agricultural-institute/SiaPy/tree/master/tutorials</a> -->
-
-__Documentation__: <https://github.com/siapy/siapy-lib/tree/main/docs>
-
-{{ version }}.
+{{ external_markdown('https://raw.githubusercontent.com/siapy/siapy-lib/main/README.md', '') }}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -64,9 +64,38 @@ nav:
       - Welcome to Siapy: index.md
       - Installation: install.md
   - API Documentation:
-      # - Entities:
-      #     - Shapes: api/entities/shapes.md
-      #     - Pixels: api/entities/pixels.md
+      - Core:
+          - Configs: api/core/configs.md
+          - Logger: api/core/logger.md
+          - Types: api/core/types.md
+      - Datasets:
+          - Helpers: api/datasets/helpers.md
+          - Schemas: api/datasets/schemas.md
+          - Tabular: api/datasets/tabular.md
+      - Entities:
+          - Images: api/entities/images.md
+          - Image Sets: api/entities/imagesets.md
+          - Pixels: api/entities/pixels.md
+          - Shapes: api/entities/shapes.md
+          - Signatures: api/entities/signatures.md
+      - Features:
+          - Features: api/features/features.md
+          - Helpers: api/features/helpers.md
+          - Spectral Indices: api/features/spectral_indices.md
+      - Models:
+          - Metrics: api/models/metrics.md
+      - Optimizers:
+          - Configs: api/optimizers/configs.md
+          - Optimizers: api/optimizers/optimizers.md
+          - Parameters: api/optimizers/parameters.md
+          - Scorers: api/optimizers/scorers.md
+      - Transformations:
+          - Corregistrator: api/transformations/corregistrator.md
+          - Image: api/transformations/image.md
+      - Utils:
+          - Evaluators: api/utils/evaluators.md
+          - Images: api/utils/images.md
+          - Plots: api/utils/plots.md
   - Contributing: contributing.md
   - Release Notes: changelog.md