Add dokka artifacts #122 #126
Conversation
|
|
charlesdurham
changed the title
There was a problem hiding this comment.
This looks pretty neat! I've always preferred using the universal gradle-mvn-push.gradle file, but can also see the value in isolating components. Let me think on this for a couple days (at Droidcon SF today and tomorrow).
CC @kageiit in case you have an opinion
gradle/dependencies.gradle
Outdated
| @@ -41,7 +42,9 @@ def build = [ | |||
| android: 'com.android.tools.build:gradle:2.3.0', | |||
| apt: 'net.ltgt.gradle:gradle-apt-plugin:0.11', | |||
| errorProne: 'net.ltgt.gradle:gradle-errorprone-plugin:0.0.11', | |||
| kotlin: "org.jetbrains.kotlin:kotlin-gradle-plugin:${versions.kotlin}" | |||
| kotlin: "org.jetbrains.kotlin:kotlin-gradle-plugin:${versions.kotlin}", | |||
| dokka: "org.jetbrains.dokka:dokka-gradle-plugin:${versions.dokka}", | |||
|
Thinking on it more, I think I'd prefer to keep everything unified in one gradle-mvn-push.gradle file. Is that good with you? Happy to shout from the rooftops that your contribution is a great example of integration with Dokka in gradle too :) |
|
Sure 👍 I consolidated everything into Let me know if you want everything inline instead. |
|
|
||
| dokka { | ||
| externalDocumentationLink { | ||
| url = new URL("http://reactivex.io/RxJava/2.x/javadoc/") |
There was a problem hiding this comment.
should this point to https://uber.github.io/AutoDispose/0.x/ ?
There was a problem hiding this comment.
Hm, what are you thinking here? That's what builds in linking between the kdoc and rxjava's doc, so if you're looking at documentation that links to rxjava you can click on it and jump straight to the rxjava documentation.
I could see adding https://uber.github.io/AutoDispose/0.x/ being useful (at least until there's proper inter-module linking). Although I think each module's doc might need to be linked independently. The dokka examples indicate you can have multiple external documentation links so if you want I could add it and keep rxjava.
I actually didn't even realize the documentation was hosted at https://uber.github.io/AutoDispose/0.x/, this PR just creates javadoc artifacts for maven.
I see https://github.com/uber/AutoDispose/tree/gh-pages/0.x but don't really know how/if the process of getting the doc in there is automated. If you can point me in the right direction I'd be happy to include that as part of this PR.
There was a problem hiding this comment.
yeah I'd held off on publicizing the docs site till dokka was figured out. I upload them via osstrich, unfortunately not sure automating it is viable vs just doing it manually after releases (don't worry about it for this PR). I didn't realize that was for dependencies of the project though, so this makes sense 👍
|
|
||
| dokka { | ||
| externalDocumentationLink { | ||
| url = new URL("http://reactivex.io/RxJava/2.x/javadoc/") |
|
Thanks! I'll give this a spin at the next release, which should be soon-ish |
So there's a lot to validate here but I think I've covered my bases, hopefully lol.
A few things I noticed:
options.link().I split out the artifact tasks into their own files because there's 4 different documentation tasks now;
I like this more than adding conditionals to
gradle-mvn-push.gradlebut I'm not super strongly opinionated so if you feel like it should all go into that file let me know and I'll update.