You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For multimodule projects configuration, it's not clear where to apply configuration options. The place differs depending on the option.
Let's consider the configuration:
If it is applied on the root project level (in dokkaHtmlMultiModule) then the styles from customStyleSheets will be propagated to all submodules. Other options will be applied only on the root level.
If it is applied on the module level (in dokkaHtmlPartial) then the customStyleSheets will be ignored and other options will be applied on the module level.
It is confusing that all of them are located in the same place.
Installation
Build tool: Gradle
Dokka version: 1.6.20
Sample project: repro.zip
Template from the root with ROOT in title applied only for root page. prism.css applied for all pages.
The relevant issue for documenting the behavior: #2202
The text was updated successfully, but these errors were encountered:
Submodules know nothing about configuration of a root project. Partial tasks do not create resource files (stylesheets, scripts) since a root project generates all resources and they are shared between the submodules. So the dokkaHtmlPartial configuration is only responsible for right tags in html: <link href="styles/west-cost-custom.css.css" rel="Stylesheet">.
In your cases:
If it is applied ONLY on the root project level then dokkaHtmlMultiModule will create west-cost-customs.css file but the stylesheet will be no applied in html of submodules. (there is not tag <link href="styles/west-cost-custom.css.css" rel="Stylesheet"> )
If it is applied ONLY on the module level (in dokkaHtmlPartial) then there will be the needed tag but the file will be not created.
Unfortunately It is not trivial.
I hope we will change the configuration dokkaHtmlMultiModule in new Gradle plugin.
Arrived here after being confused why my configuration options weren't applying in a multi-module project.
Please, at least be up-front about this incompatibility/limitation with multi-module in the Dokka documentation/how-to section. You really don't want intrepid new users to bounce off feeling frustrated and defeated because it's not behaving as advertised.
Not for want of trying either; I'm hitting it with many combinations like this:
For multimodule projects configuration, it's not clear where to apply configuration options. The place differs depending on the option.
Let's consider the configuration:
If it is applied on the root project level (in
dokkaHtmlMultiModule
) then the styles fromcustomStyleSheets
will be propagated to all submodules. Other options will be applied only on the root level.If it is applied on the module level (in
dokkaHtmlPartial
) then thecustomStyleSheets
will be ignored and other options will be applied on the module level.It is confusing that all of them are located in the same place.
Installation
Sample project: repro.zip
Template from the root with
ROOT
in title applied only for root page.prism.css
applied for all pages.The relevant issue for documenting the behavior: #2202
The text was updated successfully, but these errors were encountered: