feat: Add docs generation with Mkdocs and Dokka

Author: haroldadmin

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs
+
+on: [release]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: List directories
+      run: ls -al
+
+    - name: Setup JDK 1.8
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Setup Python dependencies
+      run: pip3 install --upgrade pip && pip3 install -r ./docs/requirements.txt
+
+    - name: Generate Docs
+      run: gradle dokkaGfm
+
+    - name: Cleanup existing docs
+      run: rm -rf docs/docs/docs/api && mkdir docs/docs/api
+
+    - name: Copy generated docs
+      run: cp -r build/dokka/coroutines-network-response-adapter/* docs/docs/docs/api
+
+    - name: Build mkdocs website
+      run: cd ./docs/docs && mkdocs build

build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id("org.jetbrains.kotlin.jvm").version("1.4.10")
+    id("org.jetbrains.dokka") version "1.4.10"
     maven
 }
 
@@ -34,3 +35,7 @@ dependencies {
     testImplementation("com.squareup.moshi:moshi-kotlin:1.9.2")
     testImplementation("com.squareup.retrofit2:converter-moshi:$retrofitVersion")
 }
+
+tasks.dokkaGfm.configure {
+    outputDirectory.set(buildDir.resolve("dokka"))
+}

docs/docs/docs/api/index.md

@@ -8,3 +8,10 @@
  */
 
 rootProject.name = "coroutines-network-response-adapter"
+
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+        jcenter()
+    }
+}