I also plan on supporting an `Api` section which i...

# arrow-contributors

[raulraja]

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

[simon.vergauwen]

Not 100% sure I follow the this. Why not just use dokka?

[raulraja]

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

[raulraja]

I may use the dokka API to read the docs and use the same code format they use

[raulraja]

So it works on both places

[raulraja]

Correct me if I missunderstand dokka

[simon.vergauwen]

I'm still don't quite follow what you want to do 😅 so couldn't say ;p

[raulraja]

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

[raulraja]

Dokka afaik would just generate API docs like traditional Java docs

[simon.vergauwen]

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.

[simon.vergauwen]

Don't think they have support for runnable docs (yet?)

[simon.vergauwen]

I did a small POC for Helios. I can push the branch and you could check it out

[raulraja]

that'd be great, thanks!

[simon.vergauwen]

https://github.com/47deg/helios/tree/add-kdoc-dokka

[simon.vergauwen]

samples: https://github.com/47deg/helios/blob/add-kdoc-dokka/helios-optics/src/test/kotlin/helios/optics/JsonPath.kt

[simon.vergauwen]

Sample in action: helios/build/kdoc/helios/helios.optics/path.html