Documentation versionning

In order to have documentation versionning, its better to have the docs stored in the repository under a folder. Therefore, the documentations are now stored in the /docs folder. The publish documentation workflow, will now load it from there.
eclipse-zenoh · Dec 21, 2023 · 28618fb · 28618fb
1 parent be3e503
commit 28618fb
Show file tree

Hide file tree

Showing 693 changed files with 74,512 additions and 13 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -12,21 +12,13 @@ jobs:
   build_doc_and_deploy:
     name: Build and Deploy Documentation
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v4
 
-      - uses: nttld/setup-ndk@v1
-        id: setup-ndk
-        with:
-          ndk-version: r26
-          add-to-path: false
-          link-to-sdk: true
-
-      - name: Build doc
-        run: gradle dokkaHtml
-
       - name: Deploy doc
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./zenoh-kotlin/build/dokka/html
+          publish_dir: ./docs
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -21,6 +21,7 @@ buildscript {
         classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.0")
         classpath("org.mozilla.rust-android-gradle:plugin:0.9.3")
         classpath("com.android.tools.build:gradle:7.4.2")
+        classpath("org.jetbrains.dokka:versioning-plugin:1.9.10")
     }
 }
 
@@ -29,7 +30,7 @@ plugins {
     id("org.jetbrains.kotlin.android") version "1.9.10" apply false
     id("org.jetbrains.kotlin.multiplatform") version "1.9.0" apply false
     id("org.mozilla.rust-android-gradle.rust-android") version "0.9.3" apply false
-    id("org.jetbrains.dokka") version "1.8.20" apply false
+    id("org.jetbrains.dokka") version "1.9.10" apply false
     id("com.adarshr.test-logger") version "3.2.0" apply false
     kotlin("plugin.serialization") version "1.9.0" apply false
 }

diff --git a/docs/images/anchor-copy-button.svg b/docs/images/anchor-copy-button.svg
diff --git a/docs/images/arrow_down.svg b/docs/images/arrow_down.svg
diff --git a/docs/images/burger.svg b/docs/images/burger.svg
diff --git a/docs/images/copy-icon.svg b/docs/images/copy-icon.svg
diff --git a/docs/images/copy-successful-icon.svg b/docs/images/copy-successful-icon.svg
diff --git a/docs/images/footer-go-to-link.svg b/docs/images/footer-go-to-link.svg
diff --git a/docs/images/go-to-top-icon.svg b/docs/images/go-to-top-icon.svg
diff --git a/docs/images/logo-icon.svg b/docs/images/logo-icon.svg
diff --git a/docs/images/nav-icons/abstract-class-kotlin.svg b/docs/images/nav-icons/abstract-class-kotlin.svg
diff --git a/docs/images/nav-icons/abstract-class.svg b/docs/images/nav-icons/abstract-class.svg
diff --git a/docs/images/nav-icons/annotation-kotlin.svg b/docs/images/nav-icons/annotation-kotlin.svg
diff --git a/docs/images/nav-icons/annotation.svg b/docs/images/nav-icons/annotation.svg
diff --git a/docs/images/nav-icons/class-kotlin.svg b/docs/images/nav-icons/class-kotlin.svg
diff --git a/docs/images/nav-icons/class.svg b/docs/images/nav-icons/class.svg
diff --git a/docs/images/nav-icons/enum-kotlin.svg b/docs/images/nav-icons/enum-kotlin.svg
diff --git a/docs/images/nav-icons/enum.svg b/docs/images/nav-icons/enum.svg
diff --git a/docs/images/nav-icons/exception-class.svg b/docs/images/nav-icons/exception-class.svg
diff --git a/docs/images/nav-icons/field-value.svg b/docs/images/nav-icons/field-value.svg
diff --git a/docs/images/nav-icons/field-variable.svg b/docs/images/nav-icons/field-variable.svg
diff --git a/docs/images/nav-icons/function.svg b/docs/images/nav-icons/function.svg
diff --git a/docs/images/nav-icons/interface-kotlin.svg b/docs/images/nav-icons/interface-kotlin.svg
diff --git a/docs/images/nav-icons/interface.svg b/docs/images/nav-icons/interface.svg