Merge pull request #6022 from vector-im/feature/bma/gh_pages

Gh pages

.github/workflows/docs.yml

@@ -0,0 +1,22 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ develop ]
+
+jobs:
+  docs:
+    name: Generate and publish Android Matrix SDK documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Build docs
+        run: ./gradlew dokkaHtml
+
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./matrix-sdk-android/build/dokka/html

matrix-sdk-android/docs/modules.md

@@ -1,5 +1,8 @@
 # Module matrix-sdk-android
 
+<!-- Note: the line below will appear only when the documentation is generated from Element-Android project, and not when it's generated from the SDK project -->
+**Note**: You are viewing the nightly documentation of the Android Matrix SDK library. The documentation of the released library can be found here: [https://matrix-org.github.io/matrix-android-sdk2/](https://matrix-org.github.io/matrix-android-sdk2/)
+
 ## Welcome to the matrix-sdk-android documentation!
 
 This pages list the complete API that this SDK is exposing to a client application.