Skip to content

Commit 13de7ab

Browse files
committed
docs: try out docs publishing workflow
1 parent c73211b commit 13de7ab

File tree

3 files changed

+49
-4
lines changed

3 files changed

+49
-4
lines changed

.github/workflows/docs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
release:
8+
types: [published]
9+
branches: [main]
10+
workflow_dispatch:
11+
12+
jobs:
13+
build-and-publish:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout sources
18+
uses: actions/checkout@v2
19+
20+
21+
- name: "Set up Python"
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: "3.10"
25+
26+
- name: Install uv
27+
uses: astral-sh/setup-uv@v5
28+
with:
29+
enable-cache: true
30+
cache-dependency-glob: "uv.lock"
31+
32+
# Step 4: Install dependencies using UV
33+
- name: Install deps
34+
run: uv sync --locked --all-extras --dev
35+
36+
- name: Deploy Docs
37+
run: |
38+
source .venv/bin/activate
39+
uv run mkdocs gh-deploy --force

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**A Python library for scalable panoptic spatial analysis of histological WSIs**
66

7-
[![Github Test](https://img.shields.io/github/actions/workflow/status/okunator/cellseg_gsontools/tests.yml?label=tests)](https://github.com/HautaniemiLab/histolytics/blob/main/.github/workflows/tests.yml)[![Generic badge](https://img.shields.io/github/license/okunator/cellseg_gsontools)](https://github.com/okunator/cellseg_gsontools/blob/master/LICENSE) [![Python - Version](https://img.shields.io/pypi/pyversions/cellseg_gsontools)](https://www.python.org/)
7+
[![Github Test](https://img.shields.io/github/actions/workflow/status/HautaniemiLab/histolytics/tests.yml?label=tests)](https://github.com/HautaniemiLab/histolytics/blob/main/.github/workflows/tests.yml)[![Generic badge](https://img.shields.io/github/license/okunator/cellseg_gsontools)](https://github.com/okunator/cellseg_gsontools/blob/master/LICENSE) [![Python - Version](https://img.shields.io/pypi/pyversions/cellseg_gsontools)](https://www.python.org/)
88

99
</div>
1010

mkdocs.yml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,17 @@ nav:
5454
- Home: index.md
5555
- Getting Started: getting_started.md
5656
- User Guide:
57-
- Installation: user_guide/installation.md
57+
- Model Fine-tuning: user_guide/fine_tuning.md
5858
- WSI Segmentation: user_guide/wsi_segmentation.md
59+
- Data Wrangling: user_guide/data_wrangling.md
60+
- Analysis Tutorials:
61+
- Nuclear Morphology: analysis_tutorials/nuclear_morphology.md
62+
- Chromatin Patterns: analysis_tutorials/chromatin_patterns.md
63+
- Collagen Fibers: analysis_tutorials/collagen_fibers.md
64+
- Stromal Morphology: analysis_tutorials/stromal_features.md
65+
- Spatial Neighborhoods: analysis_tutorials/neighborhood_analysis.md
66+
- Spatial Clustering: analysis_tutorials/clustering.md
5967
- API Reference:
6068
- WSI Segmenter: api/wsi_segmenter.md
6169
- Slide Reader: api/slide_reader.md
62-
- Tutorials:
63-
- Basic Usage: tutorials/basic_usage.md
6470
- Contributing: contributing.md

0 commit comments

Comments
 (0)