Merge pull request #8 from SLNE-Development/feat/dokka

Draft: Feat/dokka

Author: twisti-dev

.github/workflows/publish-docs.yml

@@ -0,0 +1,34 @@
+name: Publish Dokka Docs
+
+on:
+  push:
+    branches:
+      - version/1.21
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'graalvm'
+          java-version: '21'
+
+      - name: Install dependencies
+        run: ./gradlew dependencies
+
+      - name: Generate and move Dokka Docs
+        run: ./gradlew publishDokkaToDocs
+
+      - name: Commit and Push changes
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "[email protected]"
+          git add docs
+          git commit -m "Update Dokka Docs"
+          git push

.idea/compiler.xml

@@ -1,3 +1,39 @@
+import org.jetbrains.dokka.DokkaConfiguration
+import org.jetbrains.dokka.gradle.DokkaTask
+
 plugins {
     id("io.papermc.paperweight.userdev") version "2.0.0-beta.14" apply false
-}
+    alias(libs.plugins.dokka)
+}
+
+allprojects {
+    repositories {
+        mavenCentral()
+    }
+
+    if (subprojects.isEmpty()) {
+        apply(plugin = rootProject.libs.plugins.dokka.get().pluginId)
+    }
+}
+
+tasks {
+    dokkaHtml {
+        outputDirectory.set(layout.buildDirectory.dir("documentation/html"))
+    }
+
+    withType<DokkaTask>().configureEach {
+        dokkaSourceSets.configureEach {
+            documentedVisibilities = setOf(
+                DokkaConfiguration.Visibility.PUBLIC,
+                DokkaConfiguration.Visibility.PROTECTED
+            )
+        }
+    }
+
+    register<Copy>("publishDokkaToDocs") {
+        dependsOn(dokkaHtmlMultimodule)
+        from(buildDir.resolve("dokka/htmlMultiModule"))
+        into(rootDir.resolve("docs"))
+    }
+}
+

.idea/vcs.xml

@@ -58,6 +58,7 @@ maven-repo-auth = "3.0.4"
 shadow-gradle-plugin = "9.0.0-beta7"
 ksp-gradle-plugin = "2.1.10-1.0.29"
 run-paper-gradle-plugin = "2.3.1"
+dokka = "2.0.0"
 
 
 [libraries]
@@ -148,8 +149,10 @@ shadow-gradle-plugin = { module = "com.gradleup.shadow:shadow-gradle-plugin", ve
 ksp-gradle-plugin = { module = "com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin", version.ref = "ksp-gradle-plugin" }
 plugin-yml-paper-gradle-plugin = { module = "net.minecrell.plugin-yml.bukkit:net.minecrell.plugin-yml.bukkit.gradle.plugin", version.ref = "plugin-yml-paper" }
 run-paper-gradle-plugin = { module = "xyz.jpenilla.run-paper:xyz.jpenilla.run-paper.gradle.plugin", version.ref = "run-paper-gradle-plugin" }
+dokka-gradle-plugin = { module = "org.jetbrains.dokka:org.jetbrains.dokka.gradle.plugin", version.ref = "dokka" }
 
 [plugins]
 plugin-yml-paper = { id = "net.minecrell.plugin-yml.paper", version.ref = "plugin-yml-paper" }
 run-paper = { id = "xyz.jpenilla.run-paper", version.ref = "run-paper-gradle-plugin" }
 maven-repo-auth = { id = "org.hibernate.build.maven-repo-auth", version.ref = "maven-repo-auth" }
+dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }