Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gh pages #6022

Merged
merged 4 commits into from
May 11, 2022
+25 −0
Merged

Gh pages #6022

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7d85cf
Setup GitHub action to generate the documentation of the SDK from dev…
bmarty May 11, 2022
27dcb6e
Add a note when generated from this project.
bmarty May 11, 2022
7f2484c
Temporary trigger the doc generation on pull request to check the wor…
bmarty May 11, 2022
79982af
Revert "Temporary trigger the doc generation on pull request to check…
bmarty May 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Documentation

on:
pull_request: { }
bmarty marked this conversation as resolved.
Show resolved Hide resolved
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
3 changes: 3 additions & 0 deletions matrix-sdk-android/docs/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down