Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix links to external libraries in generated docs #1754

Closed
williamito opened this issue Dec 7, 2022 · 0 comments · Fixed by #1758
Closed

Fix links to external libraries in generated docs #1754

williamito opened this issue Dec 7, 2022 · 0 comments · Fixed by #1758
Assignees
@williamito
Labels
effort:medium Medium effort - 3 to 5 days type:documentation Improvements or additions to documentation

Comments

@williamito
Copy link
Contributor

Describe the bug
I had an initial PR which added Dokka support which @jingtang10 kindly refactored to avoid duplicate configs. At some point later, we discovered that links to external libraries in the generated kotlin docs were broken for the Android FHIR SDK. You can see an example here with the text and Questionnaire.QuestionnaireItemComponent not being a link to the HAPI FHIR docs.

I've finally had time to track down the PR which broke the external library links and discovered it was actually the refactor, which was checked in immediately after my PR.

Component
All library documentation

To Reproduce

  1. Checkout at d715db4 and generate docs, see that external links work
  2. Checkout at c846da8 and generate docs, see that external links are broken

Expected behavior
Links to e.g. HAPI FHIR library should work.

Additional context
I found this multimodule example which might be what we need, but I don't understand gradle well enough yet. I'm going to poke around at this for a bit longer.
williamito added a commit to williamito/android-fhir that referenced this issue Dec 8, 2022
@williamito
Change dokka configs back to being per-project to fix google#1754
a309c19
@williamito williamito mentioned this issue Dec 8, 2022
Merged
7 tasks
@aditya-07 aditya-07 added effort:medium Medium effort - 3 to 5 days type:documentation Improvements or additions to documentation labels Dec 8, 2022
jingtang10 pushed a commit that referenced this issue Dec 14, 2022
@williamito
Change dokka configs to being per-project (#1758)
9a3bb05 
* Change dokka configs back to being per-project to fix #1754

* add sourceLinks to all libraries, spotlessApply

* spotlessApply
kevinmost pushed a commit to kevinmost/android-fhir that referenced this issue Jan 4, 2023
@williamito @kevinmost
Change dokka configs to being per-project (google#1758)
b710a94 
* Change dokka configs back to being per-project to fix google#1754

* add sourceLinks to all libraries, spotlessApply

* spotlessApply
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@williamito williamito

Labels
effort:medium Medium effort - 3 to 5 days type:documentation Improvements or additions to documentation
Projects
Android FHIR SDK
Status: Complete
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Change dokka configs to being per-project williamito/android-fhir
2 participants
@williamito @aditya-07