Setup Dokka to generate html docs and document most our external functions and properties #52
Conversation
Aggree, it's obvious but it's not so evident when working on the code. It's out of the scope of this PR but we should take a look a the Explicit API mode. I've made a quick test and I think it's exactly what we need. For example, right now, we are generating doc for the 
I'll create a ticket for working on it next week and discuss over a PR. |
build.gradle.kts
Outdated
| tasks.withType<DokkaTask>().configureEach { | ||
| notCompatibleWithConfigurationCache("https://github.com/Kotlin/dokka/issues/2231") | ||
| } |
There was a problem hiding this comment.
❓ Why do we need this in the project build.gradle? We only want to apply it to the SDK module.
There was a problem hiding this comment.
We only want to apply it to the SDK module.
And ultimately, every library module if/when we split the SDK in separate components. The only module where we won't need it is the test app.
There was a problem hiding this comment.
Why do we need this in the project build.gradle?
That's a remainder of the configuration cache issues and workaround. I tried to move everything to the sub-module and it seems to work fine, so I'll move it there. We can change it later: when we add more modules or if it's still causing issues.
Sounds good! |
Setup Dokka to generate html docs and document most our external functions and properties
Dokka and gradle configuration cache are not compatible. We could disable gradle configuration cache or add a workaround, I picked the latter solution and added
notCompatibleWithConfigurationCache()when required.A few notes:
Gravatarwith a capital "G" everywhere in the documentation and public messages (eg. error logs).docs/. Generated documentation should be git ignored. I'm not sure yet where we'll store the generated docs, probably under docs.gravatar.com, so let's try to avoid duplicates.