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

Mention all-modules-page-plugin in README.md #62

Merged
merged 3 commits into from
May 3, 2023

Conversation

martinbonnin
Copy link
Contributor

@martinbonnin martinbonnin commented May 3, 2023

I understand this is required for aggregation at the moment

See #14

I understand this is required at the moment 

See adamko-dev#14
@aSemy
Copy link
Contributor

aSemy commented May 3, 2023

thanks 🙏 this would help

README.md Outdated
@@ -145,6 +145,9 @@ dependencies {
// the subprojects must also have Dokkatoo applied
dokkatoo(projects(":subproject-hello"))
dokkatoo(projects(":subproject-world"))

// This is required at the moment, see https://github.com/adamko-dev/dokkatoo/issues/14
dokkatooPluginHtml("org.jetbrains.dokka:all-modules-page-plugin:1.7.20")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version of Dokka that Dokkatoo uses by default is in a Property, which should be used so the version of Dokka is aligned.

Suggested change
dokkatooPluginHtml("org.jetbrains.dokka:all-modules-page-plugin:1.7.20")
dokkatooPluginHtml(
dokkatoo.versions.jetbrainsDokka.map { dokkaVersion ->
"org.jetbrains.dokka:all-modules-page-plugin:$dokkaVersion"
}
)

But I haven't checked this - would you be able to?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mmm, doesn't seem to work. Do you know where this is defined?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, I think this works?

dokkatooPluginHtml("org.jetbrains.dokka:all-modules-page-plugin:${org.jetbrains.dokka.DokkaVersion.version}")

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about it doesn't work? Does the script compile, or do the Gradle tasks run but it doesn't produce an aggregated publication?

dokkatoo is the regular DokkatooExtension Gradle extension, versions is an extension added to DokkatooExtension, and jetbrainsDokka is a regular Property<String> on DokkatooExtension.Versions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about it doesn't work?

Problem between chair and computer 😅 . I forgot part of your snippet and was expecting a top level dokkaVersion property 🤦 . I'll update

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's pretty hardcore to use without generated accessors though.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've got a fix in the works for making it easier to use without accessors!

It might be easier just to (finally) fix the bug, so the workaround isn't necessary! I've got an idea, I'll give it a go.

@aSemy aSemy merged commit 4b44595 into adamko-dev:main May 3, 2023
@aSemy aSemy mentioned this pull request May 3, 2023
@aSemy aSemy added this to the v1.4.0 milestone May 22, 2023
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.

2 participants