search

google / android-fhir

The Android FHIR SDK is a set of Kotlin libraries for building offline-capable, mobile-first healthcare applications using the HL7® FHIR® standard on Android.
https://google.github.io/android-fhir/
Apache License 2.0
458 stars 238 forks source link

Generate API docs site during build #2483

Closed vorburger closed 2 months ago

vorburger commented 2 months ago

Part of #2232.

Enabled by #2463, this generates the Kotlin API docs on https://google.github.io/android-fhir/ during the CI build. (They were "static" before, and just deployed from what was in the docs/ directory, with this, they are "built". This is the 1st step towards generating more documentation during the build in a future next step.)

Originally raised as #2483, but that PR for some strange reason didn't update even though I (force) pushed new commit.

@williamito or @santosh-pingle or @MJ1998 or @jingtang10 OK for you?

~Includes #2463, but just for testing; when this works, I'll merge that, and then rebase this to not include that anymore.~

~I'm marking this one as draft as I'm still testing this - please do not merge as long as it's in Draft.~

vorburger commented 2 months ago

I'm marking this one as draft as I'm still testing this - please do not merge as long as it's in Draft.

From my side, this could now be ready for review and merge; jowever, the #2485 problem is blocking merging #2463, which is holding back rebasing this so that it doesn't include that anymore, and this itself is also red because of #2485.

vorburger commented 2 months ago

This is now ready for review (and merge), from my side...

MJ1998 commented 2 months ago

This is great @vorburger