Merge pull request #26 from Bram--/dev

Add Docs.

.github/workflows/ci.yml

@@ -1,7 +1,6 @@
 name: build
 
 on:
- # Trigger the workflow on push or pull request,
  push:
  branches:
  - main
@@ -59,4 +58,4 @@ jobs:
  uses: codecov/[email protected]
  with:
  token: ${{ secrets.CODECOV_TOKEN }}
- slug: Bram--/bggclient 
+ slug: Bram--/bggclient

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: Build and Deploy
+on:
+ push:
+ branches:
+ - main
+ - release
+ workflow_dispatch:
+
+permissions:
+ contents: write
+
+jobs:
+ build-and-deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout 🛎️
+ uses: actions/checkout@v4
+
+ - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
+ run: ./gradlew dokkaHtml
+
+ - name: Deploy 🚀
+ uses: JamesIves/github-pages-deploy-action@v4
+ with:
+ folder: build/dokka/html

build.gradle.kts

@@ -3,9 +3,10 @@ plugins {
  `java-library`
  `maven-publish`
  signing
- alias(libs.plugins.org.jetbrains.kotlin.jvm)
+ alias(libs.plugins.com.gradleup.nmcp)
  alias(libs.plugins.ktfmt.gradle)
- id("com.gradleup.nmcp").version("0.0.4")
+ alias(libs.plugins.org.jetbrains.dokka)
+ alias(libs.plugins.org.jetbrains.kotlin.jvm)
 }
 
 java {

gradle/libs.versions.toml

@@ -1,10 +1,12 @@
 [versions]
+com-gradleup-nmcp = "0.0.4"
 jackson = "2.16.1"
 javax-xml-stream = "1.0-2"
 junit5 = "5.8.1"
 kermit = "2.0.3"
 ktfmt-gradle = "0.15.1"
 ktor = "2.3.8"
+org-jetbrains-dokka = "1.9.10"
 org-jetbrains-kotlin-jvm = "1.9.22"
 org-jetbrains-kotlin-jdk8 = "1.8.0"
 serialization = "1.6.3"
@@ -31,4 +33,6 @@ truth = { module = "com.google.truth:truth", version.ref = "truth" }
 [plugins]
 org-jetbrains-kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "org-jetbrains-kotlin-jvm" }
 ktfmt-gradle = { id = "com.ncorti.ktfmt.gradle", version.ref = "ktfmt-gradle" }
+com-gradleup-nmcp = { id = "com.gradleup.nmcp", version.ref = "com-gradleup-nmcp" }
+org-jetbrains-dokka = { id = "org.jetbrains.dokka", version.ref = "org-jetbrains-dokka" }