Add github pages for javadoc

Author: MinnDevelopment

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: Generate javadoc github pages
+
+on:
+  push:
+    branches: [ master ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 11
+        uses: actions/setup-java@v2
+        with:
+          java-version: 11
+          distribution: temurin
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Generate documentation directory
+        uses: gradle/gradle-build-action@v2
+        with:
+          arguments: javadoc
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/docs/javadoc
+          allow_empty_commit: true

README.md

@@ -15,6 +15,8 @@ Discord Webhook API.
 
 Here we will give a small overview of the proper usage and applicability of the resources provided by this library.
 
+Documentation is available via the GitHub pages on this repository: [Javadoc](https://minndevelopment.github.io/discord-webhooks/overview-tree.html)
+
 ## Limitations
 
 Webhooks on discord are only capable of sending messages, nothing more. For anything else you either have to use OAuth2 or a bot account. This library does not provide any functionality for creating or modifying webhooks.

build.gradle.kts

@@ -87,10 +87,28 @@ val sources = tasks.create("sources", Copy::class.java) {
     filter<ReplaceTokens>("tokens" to tokens)
 }
 
-javadoc.dependsOn(sources)
-javadoc.source = fileTree(sources.destinationDir)
-if (!System.getProperty("java.version").startsWith("1.8"))
-    (javadoc.options as CoreJavadocOptions).addBooleanOption("html5", true)
+javadoc.apply {
+    dependsOn(sources)
+    isFailOnError = false
+    source = fileTree(sources.destinationDir)
+    options.encoding = "UTF-8"
+    options.memberLevel = JavadocMemberLevel.PUBLIC
+
+    if (options is StandardJavadocDocletOptions) {
+        val opt = options as StandardJavadocDocletOptions
+
+        val extLinks = arrayOf(
+            "https://docs.oracle.com/en/java/javase/11/docs/api/",
+            "https://square.github.io/okhttp/3.x/okhttp/",
+        )
+        opt.links(*extLinks)
+        if (JavaVersion.current().isJava9Compatible)
+            opt.addBooleanOption("html5", true)
+        if (JavaVersion.current().isJava11Compatible)
+            opt.addBooleanOption("-no-module-directories", true)
+    }
+}
+
 
 val javadocJar = tasks.create("javadocJar", Jar::class.java) {
     dependsOn(javadoc)