diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000000000000000000000000000000000000..db1a9beb84433853e479227c98b27bbb8e5e0fa1 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,22 @@ +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 diff --git a/README.md b/README.md index 5c08dc614d47bc735598779b31101793411b9210..85df0f1e99b073d2738c9722ab4b0246f874f915 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,12 @@ implementation 'org.matrix.android:matrix-android-sdk2:1.2.1' Latest version:  +### 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. diff --git a/dependencies_groups.gradle b/dependencies_groups.gradle index 2c3f6a021927bfd37fc7b2cbb34cc5f66ccdf61d..8422e05930f845e53890a281bcda60c766766add 100644 --- a/dependencies_groups.gradle +++ b/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',