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.

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

Adapting Dokka configuration for multi-module projects #2930

Merged
merged 6 commits into from
Feb 22, 2023

Conversation

franciscodr
Copy link
Collaborator

This pull request uses the Dokka feature for building documentation for multi-module projects, which will solve the issue reported by @CLOVIS-AI. The current build settings treat Arrow as a single-module project causing the different modules to overwrite each other.

The proposed changes are:

  • Use dokkaHtmlMultiModule instead of dokkaGfm in the GitHub Actions workflow
  • Add settings to the Gradle file for the dokkaHtmlMultiModule and dokkaTaskPartial tasks to skip deprecated methods and set the links to the source code

@franciscodr franciscodr requested a review from a team February 13, 2023 17:10
@github-actions
Copy link
Contributor

github-actions bot commented Feb 13, 2023

Kover Report

Total Project Coverage 43.82%

@CLOVIS-AI
Copy link
Contributor

The issue was #2882 :)

@nomisRev nomisRev requested a review from a team February 17, 2023 10:19
@nomisRev
Copy link
Member

@franciscodr should we do a follow-up PR where we Copy them into /docs and setup GitHub pages already?

@franciscodr
Copy link
Collaborator Author

@franciscodr should we do a follow-up PR where we Copy them into /docs and setup GitHub pages already?

I think so. We can merge this pull request to solve the current overwriting API documentation issue. Once this is fixed, we could submit a different one for the GitHub pages setup.

@nomisRev nomisRev merged commit 2819987 into main Feb 22, 2023
@nomisRev nomisRev deleted the fd-dokka-configuration branch February 22, 2023 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants