docs

Author: stevensJourney

.github/workflows/docs-deploy.yml

@@ -0,0 +1,50 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [ 'api-ref', 'main' ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Validate Gradle Wrapper
+        uses: gradle/wrapper-validation-action@v1
+      - uses: actions/cache@v3
+        with:
+          path: ~/.konan
+          key: ${{ runner.os }}-${{ hashFiles('**/.lock') }}
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
+      - name: Gradle publish
+        run: |
+          ./gradlew dokkaGenerate
+        shell: bash
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3 # or specific "vX.X.X" version tag for this action
+        with:
+          path: build/dokka/html
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

build.gradle.kts

@@ -23,6 +23,7 @@ plugins {
     alias(libs.plugins.keeper) apply false
     alias(libs.plugins.kotlin.atomicfu) apply false
     id("org.jetbrains.dokka") version "2.0.0"
+    id("dokka-convention")
 }
 
 allprojects {
@@ -65,32 +66,18 @@ tasks.getByName<Delete>("clean") {
     delete(rootProject.layout.buildDirectory)
 }
 
-buildscript {
-    dependencies {
-        classpath("org.jetbrains.dokka:dokka-base:2.0.0")
-    }
-}
-
-dokka {
-    pluginsConfiguration.html {
-        customAssets.from("./docs/assets/powersync-logo.png")
-        customAssets.from("./docs/assets/discord.svg")
-        customAssets.from("./docs/assets/github.svg")
-        customAssets.from("./docs/assets/web.svg")
-        customAssets.from("./docs/assets/x.svg")
-        customAssets.from("./docs/assets/youtube.svg")
-        customAssets.from("./docs/assets/linkedin.svg")
-        customStyleSheets.from("./docs/assets/doc-styles.css")
-        templatesDir = file("./docs/assets/dokka-templates")
-    }
-}
-
 // Merges individual module docs into a single HTML output
 dependencies {
     dokka(project(":core:"))
     dokka(project(":connectors:supabase"))
 }
 
+dokka {
+    moduleName.set("PowerSync Kotlin")
+}
+
+// Serve the generated Dokka documentation using a simple HTTP server
+// File changes are not watched here
 tasks.register("serveDokka") {
     dependsOn("dokkaGenerate")
     doLast {

connectors/supabase/build.gradle.kts

@@ -9,6 +9,7 @@ plugins {
     alias(libs.plugins.kotlinter)
     id("com.powersync.plugins.sonatype")
     id("org.jetbrains.dokka") version "2.0.0"
+    id("dokka-convention")
 }
 
 kotlin {
@@ -52,3 +53,7 @@ android {
 }
 
 setupGithubRepository()
+
+dokka {
+    moduleName.set("PowerSync Supabase Connector")
+}

core/build.gradle.kts

@@ -19,7 +19,7 @@ plugins {
     id("com.powersync.plugins.sharedbuild")
     alias(libs.plugins.mokkery)
     alias(libs.plugins.kotlin.atomicfu)
-    id("org.jetbrains.dokka") version "2.0.0"
+    id("dokka-convention")
 }
 
 val binariesFolder = project.layout.buildDirectory.dir("binaries/desktop")
@@ -298,15 +298,5 @@ tasks.withType<KotlinTest> {
 setupGithubRepository()
 
 dokka {
-    pluginsConfiguration.html {
-        customAssets.from("../docs/assets/powersync-logo.png")
-        customAssets.from("../docs/assets/discord.svg")
-        customAssets.from("../docs/assets/github.svg")
-        customAssets.from("../docs/assets/web.svg")
-        customAssets.from("../docs/assets/x.svg")
-        customAssets.from("../docs/assets/youtube.svg")
-        customAssets.from("../docs/assets/linkedin.svg")
-        customStyleSheets.from("../docs/assets/doc-styles.css")
-        templatesDir = file("../docs/assets/dokka-templates")
-    }
+    moduleName.set("PowerSync Core")
 }

docs/assets/logo-icon.svg

@@ -4,6 +4,7 @@ android-minSdk = "24"
 android-targetSdk = "35"
 android-compileSdk = "35"
 configurationAnnotations = "0.9.5"
+dokkaBase = "2.0.0"
 gradleDownloadTask = "5.5.0"
 java = "17"
 idea = "243.22562.218" # Meerkat | 2024.3.1 (see https://plugins.jetbrains.com/docs/intellij/android-studio-releases-list.html)
@@ -56,6 +57,8 @@ junitVersion = "1.2.1"
 
 [libraries]
 configuration-annotations = { module = "co.touchlab.skie:configuration-annotations", version.ref = "configurationAnnotations" }
+dokka-base = { module = "org.jetbrains.dokka:dokka-base", version.ref = "dokkaBase" }
+dokka-gradle-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokkaBase" }
 gradle-download-task = { module = "de.undercouch:gradle-download-task", version.ref = "gradleDownloadTask" }
 kermit = { module = "co.touchlab:kermit", version.ref = "kermit" }
 kermit-test = { module = "co.touchlab:kermit-test", version.ref = "kermit" }

gradle/libs.versions.toml

@@ -3,8 +3,8 @@ plugins {
 }
 
 gradlePlugin {
-      // Define the plugin
-    val sonatypeCentralUpload by plugins.creating {
+    // Define the plugin
+    val sharedBuild by plugins.creating {
         id = "com.powersync.plugins.sharedbuild"
         implementationClass = "com.powersync.plugins.sharedbuild.SharedBuildPlugin"
     }
@@ -13,4 +13,5 @@ gradlePlugin {
 dependencies {
     implementation(libs.gradle.download.task)
     implementation(libs.kotlin.gradle.plugin)
+    implementation(libs.dokka.gradle.plugin)
 }

plugins/build-plugin/build.gradle.kts

@@ -0,0 +1,21 @@
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+// Shared Dokka config
+dokka {
+    pluginsConfiguration.html {
+        val docsAssetsDir = rootProject.file("docs/assets")
+
+        customAssets.from(docsAssetsDir.resolve("powersync-logo.png"))
+        customAssets.from(docsAssetsDir.resolve("logo-icon.svg"))
+        customAssets.from(docsAssetsDir.resolve("discord.svg"))
+        customAssets.from(docsAssetsDir.resolve("github.svg"))
+        customAssets.from(docsAssetsDir.resolve("web.svg"))
+        customAssets.from(docsAssetsDir.resolve("x.svg"))
+        customAssets.from(docsAssetsDir.resolve("youtube.svg"))
+        customAssets.from(docsAssetsDir.resolve("linkedin.svg"))
+        customStyleSheets.from(docsAssetsDir.resolve("doc-styles.css"))
+        templatesDir = file(docsAssetsDir.resolve("dokka-templates"))
+    }
+}