Feature/mkdocs (#138)

* proper documentation
a-sit-plus · Sep 27, 2024 · 538846d · 538846d
1 parent 91997c7
commit 538846d
Show file tree

Hide file tree

Showing 49 changed files with 13,415 additions and 152 deletions.
diff --git a/.github/workflows/publish-dry-run.yml b/.github/workflows/publish-dry-run.yml
@@ -25,12 +25,19 @@ jobs:
           ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.PUBLISH_SONATYPE_USER }}
           ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.PUBLISH_SONATYPE_PASSWORD }}
   deploy-docs:
-    needs: build
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
           submodules: recursive
+      - uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
       - name: Build Dokka HTML
-        run: ./gradlew dokkaHtmlMultiModule
+        run: ./gradlew mkDocsBuild
diff --git a/.github/workflows/publish-pages-only.yml b/.github/workflows/publish-pages-only.yml
@@ -9,7 +9,7 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -19,15 +19,19 @@ jobs:
         with:
           distribution: 'temurin'
           java-version: '17'
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
       - name: Build Dokka HTML
-        run: ./gradlew dokkaHtmlMultiModule
+        run: ./gradlew mkDocsBuild
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
           # Upload docs folder
-          path: './build/dokka'
+          path: './docs/site'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -25,11 +25,10 @@ jobs:
           ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.PUBLISH_SONATYPE_USER }}
           ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.PUBLISH_SONATYPE_PASSWORD }}
   deploy-docs:
-    needs: build
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -39,15 +38,20 @@ jobs:
         with:
           distribution: 'temurin'
           java-version: '17'
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
       - name: Build Dokka HTML
-        run: ./gradlew dokkaHtmlMultiModule
+        run: ./gradlew mkDocsBuild
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
           # Upload docs folder
-          path: './build/dokka'
+          path: './docs/site'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
+
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+docs/docs/CHANGELOG.md
+docs/docs/dokka/
+docs/site/
+
 */generated
 .gradle
 demoapp/build