Change API documentation to GFM

MiSikora / laboratory

Feature flags for multi-module Kotlin Android projects

https://mehow.io/laboratory/

Apache License 2.0

82 stars 3 forks source link

Change API documentation to GFM #31

Open MiSikora opened 4 years ago

MiSikora commented 4 years ago

Dokka should provide GFM output that can be used by MkDocs to deploy it to the website.

MiSikora commented 4 years ago

Right now Dokka 1.4.10.2 produces horrendous output. Will revisit this some time in the future.

Or I can write a script that polishes Dokka output.

MiSikora commented 3 years ago

Output got a little bit better with 1.4.20 (still not perfect but manageable). However it still documents inherited methods or fields (including package private ones) and so on.