Create nice documentation and publish to GH pages #44
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andresuribe87
requested review from
mistermoe and
nitro-neal
as code owners
nitro-neal
reviewed
Sep 27, 2023
|
|
||
| localDirectory.set(rootProject.projectDir) | ||
| remoteUrl.set(URL(exampleDir)) | ||
| remoteLineSuffix.set("#L") |
There was a problem hiding this comment.
Have no idea, just copy pasted from the examples 🤷
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Create nice HTML docs using dokka.
Description
This examples is based on https://github.com/Kotlin/dokka/blob/master/examples/gradle/dokka-multimodule-example/README.md
How Has This Been Tested?
See the example of what this looks like locally:
The CI was tested and I was able to see the contents in https://tbd54566975.github.io/web5-sdk-kotlin/docs/htmlMultiModule/index.html
References
https://kotlinlang.org/docs/dokka-gradle.html