orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you
https://orchid.run
GNU General Public License v3.0
520 stars 53 forks source link

Kotlin Multiplatform #371

Closed JavierSegoviaCordoba closed 4 years ago

JavierSegoviaCordoba commented 4 years ago

I can't generate Kotlin docs from a Kotlin multiplatform module.

How can I setup Orchid? Or the sourceDirs?

cjbrooks12 commented 4 years ago

I actually haven't tried using it with multiplatform Kotlin code. I'll have to try that out today to know for sure how well it works.

cjbrooks12 commented 4 years ago

I was able to get MPP docs set up correctly in a trivial case (example). Having each MPP target as separate "modules" (see Multi-Module setup) for the Kotlindocs is probably the way you'd want to do it. I'm not sure how well it will hold up under real-world usage, so I'd welcome any feedback you have for it, formatting issues, things rendering/linking incorrectly, etc.

JavierSegoviaCordoba commented 4 years ago

I will try it later because I see some differences in your config.

cjbrooks12 commented 4 years ago

The Orchid configuration is completely separate from the Gradle setup. You'd still set up the MPP project however you need, and then just point Orchid to the appropriate source directories. Having multiple "orchid modules" just keeps the platform-specific implementation code separated since it doesn't currently have a way to differentiate platforms

cjbrooks12 commented 4 years ago

Is it the JavierSegoviaCordoba/Core you're working with? It seems to be working fine when I run it with no changes from that repo.

Screen Shot 2020-04-20 at 4 03 54 PM