Merge pull request #34 from snabble/simplify_docs

Use dokka html documentation

Author: rekire

.github/workflows/publish.yml

@@ -26,10 +26,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: ./gradlew publishAllPublicationsToGitHubPackagesRepository
       - name: Generate documentation
-        run: ./gradlew dokkaGfmMultiModule && sed -E 's/^## \[([^[]+)\]$/## \1/g' CHANGELOG.md | sed -E 's/^### (.+)$/**\1**\n/g' | sed -E 's/All notable changes to this project will be documented in this file./All notable changes of the Android SDK are noted in this document./' > docs/docs/changelog.md
+        run: ./gradlew dokkaHtmlMultiModule && sed -E 's/^## \[([^[]+)\]$/## \1/g' CHANGELOG.md | sed -E 's/^### (.+)$/**\1**\n/g' | sed -E 's/All notable changes to this project will be documented in this file./All notable changes of the Android SDK are noted in this document./' > docs/docs/changelog.md
       - name: Deploy documentation
-        uses: mhausenblas/mkdocs-deploy-gh-pages@nomaterial
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CONFIG_FILE: docs/mkdocs.yml
-          REQUIREMENTS: docs/requirements.txt
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs

build.gradle

@@ -75,8 +75,10 @@ tasks.named("dokkaHtml").configure {
         }
     }
 }
+
 tasks.withType(org.jetbrains.dokka.gradle.AbstractDokkaTask).configureEach {
-    outputDirectory.set(rootDir.toPath().resolve("docs/docs/api").toFile())
+    outputDirectory.set(rootDir.toPath().resolve("docs").toFile())
+    suppressObviousFunctions.set(true)
 }
 
 task printVersion() {