-
Notifications
You must be signed in to change notification settings - Fork 305
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.
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
Adds Gradle task dokkaHtml
to run Dokka document generation
#1466
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1466 +/- ##
============================================
- Coverage 75.22% 74.56% -0.66%
- Complexity 650 660 +10
============================================
Files 128 128
Lines 3943 3995 +52
Branches 721 726 +5
============================================
+ Hits 2966 2979 +13
- Misses 591 620 +29
- Partials 386 396 +10
Help us with your feedback. Take ten seconds to tell us how you rate us. |
what's the command to be run to generate the docs? |
You can generate docs like this for datacapture, you can specify the other subprojects as well:
Make sure to gradle sync successfully first, it seems a bit fickle about downloading Dokka from the plugins line sometimes. |
dokkaHtml
to run Dokka document generation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can the config block be made into a Dokka.kt
file in the buildSrc
directory? Examples:
https://github.com/google/android-fhir/blob/master/buildSrc/src/main/kotlin/JacocoConfig.kt
https://github.com/google/android-fhir/blob/master/buildSrc/src/main/kotlin/SpotlessConfig.kt
https://github.com/google/android-fhir/blob/master/buildSrc/src/main/kotlin/LicenseeConfig.kt
I am not sure how to manage this, given how the Dokka plugin auto-creates tasks for every module it is added to. Would it be okay to merge having fixed your other comments? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks william - the introduction of the util function in buildSrc will be done in my pr #1503
IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).
Fixes #1457
Description
Adds simple Gradle tasks to run Dokka document generation.
Alternative(s) considered
None; would love discussion on how to integrate doc generation better with current release processes however.
Type
Documentation
Screenshots (if applicable)
![image](https://user-images.githubusercontent.com/7772901/174883375-c0429af5-3263-467f-932e-cfe4cc6a769e.png)
Checklist
./gradlew spotlessApply
and./gradlew spotlessCheck
to check my code follows the style guide of this project../gradlew check
and./gradlew connectedCheck
to test my changes locally.