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

fix: added dokka and fix doc generation #1249

Merged
merged 1 commit into from
Oct 26, 2023

Conversation

kikoso
Copy link
Collaborator

@kikoso kikoso commented Oct 25, 2023

This PR fixes the doc generation, broken since 3.4.0.

JavaDoc does not like Kotlin, so we are updating it to a more modern documentation framework, Dokka. We are adding also a new flow to upload the documentation to the GitHub pages.


Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open a GitHub issue as a bug/feature request before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Edit the title of this pull request with a semantic commit prefix (e.g. "fix: "), which is necessary for automated release workflows to decide whether to generate a new release and what type it should be.
  • Will this cause breaking changes to existing Java or Kotlin integrations? If so, ensure the commit has a BREAKING CHANGE footer so when this change is integrated a major version update is triggered. See: https://www.conventionalcommits.org/en/v1.0.0/
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #1248 🦕

@kikoso kikoso requested a review from a team as a code owner October 25, 2023 18:13
@kikoso kikoso requested a review from willum070 October 25, 2023 18:13
@wangela wangela requested review from wangela and removed request for willum070 October 25, 2023 21:35
@wangela wangela merged commit de47276 into main Oct 26, 2023
8 checks passed
@wangela wangela deleted the fix/added_dokka_and_fix_doc_generation branch October 26, 2023 15:44
googlemaps-bot pushed a commit that referenced this pull request Oct 26, 2023
## [3.6.1](v3.6.0...v3.6.1) (2023-10-26)

### Bug Fixes

* add dokka and fix doc generation ([#1249](#1249)) ([de47276](de47276))
@googlemaps-bot
Copy link
Contributor

🎉 This PR is included in version 3.6.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refdocs stuck at v3.4.0
3 participants