Merge pull request #8 from matrix-org/feature/bma/publish_doc

Publish doc

.github/workflows/docs.yml

+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+
+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

README.md

@@ -28,6 +28,12 @@ implementation 'org.matrix.android:matrix-android-sdk2:1.2.1'
 
 Latest version: ![Latest version](https://img.shields.io/maven-central/v/org.matrix.android/matrix-android-sdk2)
 
+### API documentation
+
+The Matrix Android SDK2 API documentation can be found here: https://matrix-org.github.io/matrix-android-sdk2
+
+We are currently working to improve it.
+
 ### Sample application
 
 You can have a look on the sample app we have written to help starting with the new SDK: https://github.com/matrix-org/matrix-android-sdk2-sample.

dependencies_groups.gradle

@@ -164,6 +164,7 @@ ext.groups = [
                         'org.codehaus.woodstox',
                         'org.eclipse.ee4j',
                         'org.ec4j.core',
+                        'org.freemarker',
                         'org.glassfish.jaxb',
                         'org.hamcrest',
                         'org.jacoco',