Automatically generating Dokka API docs using Github Actions and deploying to Github Pages

You are currently viewing Automatically generating Dokka API docs using Github Actions and deploying to Github Pages

Automatically generating Dokka API docs using Github Actions and deploying to Github Pages

I just got this working and though it would be useful to share.

First step is to configure Dokka in your build.gradle:

plugins { ... id 'org.jetbrains.dokka' version '1.4.0-rc' ... }

Next configure the Github Action, you can see how I’ve done it here.

This will deploy the documentation to the gh-pages branch of your respository, see here for more information.

You can see the result here: http://dokka.kweb.io/kweb-core/

submitted by /u/sanity
[link] [comments]