Dokka

.github/workflows/docs.yml

@@ -72,21 +72,34 @@ jobs:
     needs: [ build, test ]
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Move API docs to the publication directory
+        run:
+          mkdir __docs_publication_dir
+          cp -r docs/pages/api __docs_publication_dir/api
+
       - name: Download artifacts
         uses: actions/download-artifact@v4
         with:
           name: kotlinx-rpc
 
       - name: Unzip artifact
-        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
+        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d __docs_publication_dir
+
+      - name: Update sitemap.xml
+        run: chmod +x updateSitemap.sh && ./updateSitemap.sh __docs_publication_dir/sitemap.xml __docs_publication_dir/api
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
       - name: Package and upload Pages artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: dir
+          path: __docs_publication_dir
 
       - name: Deploy to GitHub Pages
         id: deployment

.github/workflows/dokka.yml

@@ -0,0 +1,21 @@
+name: Verify API Docs
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  verify-api-docs:
+    name: Up-To-Date Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Sources
+        uses: actions/checkout@v4
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+      - name: Check Dokka generation is up-to-date
+        run: ./gradlew dokkaGenerate
+      - name: Check Dokka HTML output is up-to-date
+        run: git status --porcelain | grep "docs/pages/api/" && echo "Run `./gradlew dokkaGenerate` to update API docs and commit changes" && exit 1 || exit 0

build.gradle.kts

@@ -3,22 +3,60 @@
  */
 
 import org.jetbrains.kotlin.gradle.plugin.getKotlinPluginVersion
+import util.asDokkaVersion
 import util.configureApiValidation
 import util.configureNpm
 import util.configureProjectReport
 import util.registerDumpPlatformTableTask
 import util.libs
 import util.registerVerifyPlatformTableTask
+import java.time.Year
 
 plugins {
     alias(libs.plugins.serialization) apply false
     alias(libs.plugins.kotlinx.rpc) apply false
     alias(libs.plugins.conventions.kover)
     alias(libs.plugins.conventions.gradle.doctor)
+    alias(libs.plugins.dokka)
     alias(libs.plugins.atomicfu)
     id("build-util")
 }
 
+dokka {
+    val libDokkaVersion = libs.versions.kotlinx.rpc.get().asDokkaVersion()
+
+    moduleVersion.set(libDokkaVersion)
+
+    val dokkaVersionsDirectory = layout.projectDirectory
+        .dir("docs")
+        .dir("pages")
+        .dir("api")
+        .asFile
+
+
+    pluginsConfiguration {
+        html {
+            customAssets.from(".github/images/logo-icon.svg")
+            footerMessage = "© ${Year.now()} JetBrains s.r.o and contributors. Apache License 2.0"
+        }
+
+        // enable versioning for stable
+//        versioning {
+//            version = libDokkaVersion
+//            olderVersionsDir = dokkaVersionsDirectory
+//        }
+    }
+
+    dokkaPublications.html {
+        outputDirectory = dokkaVersionsDirectory
+    }
+
+    dokkaGeneratorIsolation = ProcessIsolation {
+        // Configures heap size, use if start to fail with OOM on CI
+//        maxHeapSize = "4g"
+    }
+}
+
 configureProjectReport()
 configureNpm()
 configureApiValidation()