From 491a307f14fad8f55a2fb3e9ae7feee179caaef2 Mon Sep 17 00:00:00 2001 From: Kalman Bencze Date: Thu, 8 Jan 2026 15:52:43 +0200 Subject: [PATCH] fixed the dokka aggregated docs publishing --- .github/workflows/publish-docs.yml | 8 ++++---- arsceneview/build.gradle.kts | 19 ++++--------------- build.gradle.kts | 11 +++++++++++ sceneview/build.gradle.kts | 19 ++++--------------- 4 files changed, 23 insertions(+), 34 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 4e863115..8441d778 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -12,22 +12,22 @@ jobs: steps: - name: Check out code uses: actions/checkout@v2 - - name: Set up JDK 17 + - name: Set up JDK 21 uses: actions/setup-java@v2 with: distribution: adopt - java-version: 17 + java-version: 21 - name: Make gradlew executable run: chmod +x ./gradlew - name: Generate Dokka HTML docs - run: ./gradlew dokkaHtmlMultiModule + run: ./gradlew dokkaGenerate - name: Deploy to GitHub pages uses: peaceiris/actions-gh-pages@v3 with: personal_token: ${{ secrets.PERSONAL_TOKEN }} external_repository: SceneView/sceneview.github.io publish_branch: main - publish_dir: ./build/dokka/htmlMultiModule + publish_dir: ./build/dokka/html destination_dir: api/sceneview-android full_commit_message: Dokka docs - sceneview-android enable_jekyll: false \ No newline at end of file diff --git a/arsceneview/build.gradle.kts b/arsceneview/build.gradle.kts index d86f0953..bc79b6c5 100644 --- a/arsceneview/build.gradle.kts +++ b/arsceneview/build.gradle.kts @@ -68,20 +68,9 @@ mavenPublishing { } dokka { - moduleName.set("SceneView Android") - dokkaSourceSets.configureEach { - externalDocumentationLinks.register("example-docs") { - url("https://example.com/docs/") - packageListUrl("https://example.com/docs/package-list") - } - } + moduleName.set("ArSceneView Android - 3D and AR") dokkaSourceSets.main { - includes.from("README.md") - sourceLink { - localDirectory.set(file("src/main/kotlin")) - remoteUrl("https://example.com/src") - remoteLineSuffix.set("#L") - } + includes.from("../README.md") reportUndocumented.set(true) skipEmptyPackages.set(true) skipDeprecated.set(true) @@ -103,9 +92,9 @@ dokka { } sourceLink { - localDirectory.set(project.file("src/main/kotlin")) + localDirectory.set(project.file("src/main/java")) // URL showing where the source code can be accessed through the web browser - remoteUrl("https://github.com/sceneview/sceneview-android/blob/main/${project.name}/src/main/kotlin") + remoteUrl("https://github.com/sceneview/sceneview-android/tree/main/${project.name}/src/main/java") // Suffix which is used to append the line number to the URL. Use #L for GitHub remoteLineSuffix.set("#L") } diff --git a/build.gradle.kts b/build.gradle.kts index 85de6db9..e85c26f6 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -4,4 +4,15 @@ plugins { alias(libs.plugins.compose.compiler ) apply false alias(libs.plugins.publish) apply false alias { libs.plugins.dokka } apply true +} + +dokka { + dokkaPublications.html { + includes.from(project.layout.projectDirectory.file("README.md")) + } +} + +dependencies { + dokka(projects.arsceneview) + dokka(projects.sceneview) } \ No newline at end of file diff --git a/sceneview/build.gradle.kts b/sceneview/build.gradle.kts index 342e1c3f..dde6b734 100644 --- a/sceneview/build.gradle.kts +++ b/sceneview/build.gradle.kts @@ -77,20 +77,9 @@ mavenPublishing { } dokka { - moduleName.set("SceneView Android") - dokkaSourceSets.configureEach { - externalDocumentationLinks.register("example-docs") { - url("https://example.com/docs/") - packageListUrl("https://example.com/docs/package-list") - } - } + moduleName.set("SceneView Android - 3D") dokkaSourceSets.main { - includes.from("README.md") - sourceLink { - localDirectory.set(file("src/main/kotlin")) - remoteUrl("https://example.com/src") - remoteLineSuffix.set("#L") - } + includes.from("../README.md") reportUndocumented.set(true) skipEmptyPackages.set(true) skipDeprecated.set(true) @@ -112,9 +101,9 @@ dokka { } sourceLink { - localDirectory.set(project.file("src/main/kotlin")) + localDirectory.set(project.file("src/main/java")) // URL showing where the source code can be accessed through the web browser - remoteUrl("https://github.com/sceneview/sceneview-android/blob/main/${project.name}/src/main/kotlin") + remoteUrl("https://github.com/sceneview/sceneview-android/tree/main/${project.name}/src/main/java") // Suffix which is used to append the line number to the URL. Use #L for GitHub remoteLineSuffix.set("#L") }