Merge branch 'main' into feature/radial-placement

Author: linde9821

.github/workflows/deploy-docs.yml

@@ -0,0 +1,56 @@
+name: Deploy API Docs
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'library/src/**'
+      - 'library/build.gradle.kts'
+      - 'gradle/libs.versions.toml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 17
+
+      - uses: gradle/actions/setup-gradle@v4
+
+      - name: Build wasmJs sample
+        run: ./gradlew :sample:wasmJsBrowserDistribution
+
+      - name: Generate API docs
+        run: ./gradlew :library:dokkaGeneratePublicationHtml
+
+      - name: Assemble site
+        run: |
+          mkdir -p _site
+          cp -r sample/build/dist/wasmJs/productionExecutable/* _site/
+          cp -r library/build/dokka/html _site/api
+
+      - uses: actions/configure-pages@v5
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/deploy-web.yml

@@ -1,43 +1,12 @@
-name: Deploy Web Sample
+# Superseded by deploy-docs.yml which deploys both the sample and API docs.
+# Kept as a placeholder to avoid breaking existing workflow references.
+name: Deploy Web Sample (deprecated)
 
 on:
-  push:
-    branches: [ main ]
   workflow_dispatch:
 
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: pages
-  cancel-in-progress: true
-
 jobs:
-  deploy:
+  redirect:
     runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
     steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-java@v4
-        with:
-          distribution: zulu
-          java-version: 17
-
-      - uses: gradle/actions/setup-gradle@v4
-
-      - name: Build wasmJs distribution
-        run: ./gradlew :sample:wasmJsBrowserDistribution
-
-      - uses: actions/configure-pages@v5
-
-      - uses: actions/upload-pages-artifact@v3
-        with:
-          path: sample/build/dist/wasmJs/productionExecutable
-
-      - id: deployment
-        uses: actions/deploy-pages@v4
+      - run: echo "Use deploy-docs.yml instead"

README.md

@@ -4,6 +4,8 @@
 
 [![Maven Central](https://img.shields.io/maven-central/v/io.github.linde9821/treelayout-kmp)](https://central.sonatype.com/artifact/io.github.linde9821/treelayout-kmp)
 
+**[Live Demo](https://linde9821.github.io/TreeLayoutKMP/)** · **[API Docs](https://linde9821.github.io/TreeLayoutKMP/api/)**
+
 > ⚠️ **This library is under active development and has not reached a stable release yet.**
 > The API may change between versions. Feedback and contributions are welcome.
 
@@ -19,8 +21,6 @@ your nodes; the library computes optimal (x, y) coordinates for every node in th
 > **Note:** This library is a *layout engine*, not a rendering library. It outputs coordinates — how you draw the tree
 > (Canvas, SVG, Compose, HTML, etc.) is entirely up to you.
 
-**[Try the live demo on GitHub Pages](https://linde9821.github.io/TreeLayoutKMP/)**
-
 ## Supported Targets
 
 | JVM | Android | iOS | macOS | tvOS | watchOS | Linux | Windows | JS | Wasm |

build.gradle.kts

@@ -4,6 +4,7 @@ plugins {
     alias(libs.plugins.vanniktech.mavenPublish) apply false
     alias(libs.plugins.compose) apply false
     alias(libs.plugins.compose.compiler) apply false
+    alias(libs.plugins.dokka) apply false
 }
 
 allprojects {

gradle.properties

@@ -1,5 +1,7 @@
 #Gradle
 org.gradle.jvmargs=-Xmx4096M -XX:MaxMetaspaceSize=1g -Dfile.encoding=UTF-8
+#Dokka
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
 kotlin.daemon.jvmargs=-Xmx4096M
 org.gradle.caching=true
 org.gradle.configuration-cache=true

gradle/libs.versions.toml

@@ -8,6 +8,7 @@ compose-version = "1.10.3"
 lets-plot-kotlin = "4.13.0"
 lets-plot = "4.8.2"
 lets-plot-platf = "4.9.0"
+dokka = "2.0.0"
 
 [libraries]
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
@@ -20,4 +21,5 @@ android-kotlin-multiplatform-library = { id = "com.android.kotlin.multiplatform.
 kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 vanniktech-mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "vanniktechMavenPublish" }
 compose = { id = "org.jetbrains.compose", version.ref = "compose-version" }
-compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }

library/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
     alias(libs.plugins.kotlinMultiplatform)
     alias(libs.plugins.android.kotlin.multiplatform.library)
     alias(libs.plugins.vanniktech.mavenPublish)
+    alias(libs.plugins.dokka)
 }
 
 group = "io.github.linde9821"