From d68e1bba68ef40433e12449a04ef4892d7a810ff Mon Sep 17 00:00:00 2001 From: niklasmueboe Date: Tue, 24 Jun 2025 09:48:33 +0200 Subject: [PATCH 1/5] add consensus to docs --- docs/modules/consensus.md | 1 + docs/modules/index.md | 1 + mkdocs.yml | 1 + 3 files changed, 3 insertions(+) create mode 120000 docs/modules/consensus.md diff --git a/docs/modules/consensus.md b/docs/modules/consensus.md new file mode 120000 index 00000000..4083628c --- /dev/null +++ b/docs/modules/consensus.md @@ -0,0 +1 @@ +../../consensus/README.md \ No newline at end of file diff --git a/docs/modules/index.md b/docs/modules/index.md index e666ad68..b7c85c56 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -5,6 +5,7 @@ The Spacehack 2.0 workflow consists of multiple module types: - [Datasets](data.md) to analyze - [Methods](method.md) to identify spatial doamins - [Metrics](metric.md) to evaluate performance against a groundtruth +- [Consensus](consensus.md) to build a consensus clustering across multiple methods If you want to generate a new module you have to make sure to follow the format and specification as defined in their respective sections. diff --git a/mkdocs.yml b/mkdocs.yml index 9fae23ac..6b5cfa3c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,7 @@ nav: - Data: modules/data.md - Method: modules/method.md - Metric: modules/metric.md + - Consensus: modules/consensus.md - Extending & Contributing: contributing.md - About: - SpaceHack: https://spatialhackathon.github.io/ From 730139eefdc04105260cee5a3e3e6d458083ed01 Mon Sep 17 00:00:00 2001 From: niklasmueboe Date: Tue, 24 Jun 2025 10:02:04 +0200 Subject: [PATCH 2/5] action to test build docs --- .github/workflows/build_mkdocs.yml | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_mkdocs.yml b/.github/workflows/build_mkdocs.yml index fadb7141..ebd37392 100644 --- a/.github/workflows/build_mkdocs.yml +++ b/.github/workflows/build_mkdocs.yml @@ -1,7 +1,12 @@ -name: Deploy MkDocs to GitHub Pages +name: Build and deploy MkDocs to GitHub Pages on: + pull_request: + # Test build for PRs targeting default branch + branches: + - native push: + # Deploy on push to default branch branches: - native @@ -20,5 +25,13 @@ jobs: run: | python -m pip install --upgrade pip pip install -r docs/requirements.txt - - name: Build and deploy MkDocs + + - name: Build MkDocs site (strict) + # Test build on PR to native branch + if: github.event_name == 'pull_request' + run: mkdocs build --strict + + - name: Deploy to GitHub Pages + # Deploy on push to native branch + if: github.event_name == 'push' && github.ref == 'refs/heads/native' run: mkdocs gh-deploy --force From 4969db53a20f149e7fdc053bb045c0f66f5f3b0b Mon Sep 17 00:00:00 2001 From: niklasmueboe Date: Tue, 24 Jun 2025 10:04:51 +0200 Subject: [PATCH 3/5] fix warnings when building docs --- docs/{contributing.md => CONTRIBUTING.md} | 0 mkdocs.yml | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/{contributing.md => CONTRIBUTING.md} (100%) diff --git a/docs/contributing.md b/docs/CONTRIBUTING.md similarity index 100% rename from docs/contributing.md rename to docs/CONTRIBUTING.md diff --git a/mkdocs.yml b/mkdocs.yml index 6b5cfa3c..9ee7bcf3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,7 +12,7 @@ nav: - Method: modules/method.md - Metric: modules/metric.md - Consensus: modules/consensus.md - - Extending & Contributing: contributing.md + - Extending & Contributing: CONTRIBUTING.md - About: - SpaceHack: https://spatialhackathon.github.io/ - Repository: https://github.com/SpatialHackathon/SACCELERATOR From 3e543d38aa48e2d9c548e1e4c22d74095509d63f Mon Sep 17 00:00:00 2001 From: niklasmueboe Date: Tue, 24 Jun 2025 10:08:04 +0200 Subject: [PATCH 4/5] rename wokflow step --- .github/workflows/build_mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build_mkdocs.yml b/.github/workflows/build_mkdocs.yml index ebd37392..c2d57c32 100644 --- a/.github/workflows/build_mkdocs.yml +++ b/.github/workflows/build_mkdocs.yml @@ -14,7 +14,7 @@ permissions: contents: write jobs: - deploy: + build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 From c3ab400e2cd2992f9abf8bb5f333f3ed1bd5a624 Mon Sep 17 00:00:00 2001 From: niklasmueboe Date: Tue, 24 Jun 2025 10:08:17 +0200 Subject: [PATCH 5/5] fix broken link --- docs/modules/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/index.md b/docs/modules/index.md index b7c85c56..4901e3bc 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -9,6 +9,6 @@ The Spacehack 2.0 workflow consists of multiple module types: If you want to generate a new module you have to make sure to follow the format and specification as defined in their respective sections. -Also, it might be worth having a look at the [Contribution guide](../contributing.md). +Also, it might be worth having a look at the [Contribution guide](../CONTRIBUTING.md). ![Workflow](../img/workflow.svg)