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

Sub-modules don't inherit the footer message for HTML Dokka docs #111

Open
EdricChan03 opened this issue Aug 3, 2023 · 2 comments
Open
Labels
documentation Improvements or additions to documentation format:html Relates to Dokka HTML publication format

Comments

@EdricChan03
Copy link
Contributor

It appears that sub-modules don't inherit the footer message defined from the root module's pluginConfiguration.html block:

plugins {
  dev.adamko.`dokkatoo-html`
}

dokkatoo {
    pluginsConfiguration.html {
        // ...
        footerMessage.set("&copy; 2023 <...>")
    }
}
@aSemy
Copy link
Contributor

aSemy commented Aug 3, 2023

Thanks for the report!

I suspect that customising the footer has to be done in the aggregating project, and this is a limitation of the Dokka HTML plugin, which Dokkatoo doesn't 'own'. But that's a suspicion, I'd have to look through the Dokka HTML plugin code to verify.

@aSemy aSemy added the format:html Relates to Dokka HTML publication format label Aug 3, 2023
@aSemy
Copy link
Contributor

aSemy commented Aug 6, 2023

It looks like my suspicion was right: Kotlin/dokka#2419

Dokkatoo could add some notes to the KDoc of the HTML plugin options to try to help, which isn't great (because it would still be possible to make a mistake) but I don't think anything else is possible. What do you think @EdricChan03?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation format:html Relates to Dokka HTML publication format
Projects
None yet
Development

No branches or pull requests

2 participants