https://kotlinlang.org logo
Title
r

raulraja

11/13/2018, 6:33 PM
I also plan on supporting an
Api
section which is instrospected from the type listing all its public API and deriving runnable examples from the Kdoc they are annotated with
s

simon.vergauwen

11/13/2018, 6:36 PM
Not 100% sure I follow the this. Why not just use dokka?
r

raulraja

11/13/2018, 6:38 PM
Dokka is great and we can use to generate the API docs. But when we want info from the types in Jekyll in markdown we can't intermix dokka in our docs afaik
I may use the dokka API to read the docs and use the same code format they use
So it works on both places
Correct me if I missunderstand dokka
s

simon.vergauwen

11/13/2018, 6:39 PM
I'm still don't quite follow what you want to do 😅 so couldn't say ;p
r

raulraja

11/13/2018, 6:43 PM
I want o generate a block embedded in our docs including the list of public methods and if they contain examples in their kdoc include them for the playgrounds in our site to run them
Dokka afaik would just generate API docs like traditional Java docs
s

simon.vergauwen

11/13/2018, 6:45 PM
Dokka does a little more. You can also inline examples that are written as tests and IntelliJ also has tooling to show it in tooling.
Don't think they have support for runnable docs (yet?)
I did a small POC for Helios. I can push the branch and you could check it out
r

raulraja

11/13/2018, 6:46 PM
that'd be great, thanks!
s

simon.vergauwen

11/13/2018, 6:58 PM
Sample in action:
helios/build/kdoc/helios/helios.optics/path.html
👍 1