-
Notifications
You must be signed in to change notification settings - Fork 30
misc: upgrade to Dokka 2.0.0 #1284
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
base: main
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
Affected ArtifactsNo artifacts changed size |
@@ -0,0 +1,30 @@ | |||
import kotlin.text.set |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: I like the idea of refactoring this out of the main build file. How much more work would it be to move it all the way out into aws-kotlin-repo-tools so that we had less duplication?
// Output subprojects' docs to <docs-base>/project-name/* instead of <docs-base>/path/to/project-name/* | ||
// This is especially important for inter-repo linking (e.g., via externalDocumentationLink) because the | ||
// package-list doesn't contain enough project path information to indicate where modules' documentation are | ||
// located. | ||
fileLayout.set { parent, child -> | ||
parent.outputDirectory.dir(child.moduleName) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does dokka handle this now or is the layout going to change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This didn't seem to be necessary anymore in my testing. It was an old bit of code, might have been fixed a long time ago or just now in Dokka 2.0.0
dependencies { | ||
dokka(project(":runtime")) | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need this now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean the dokka(project(":runtime"))
? This is how you aggregate multi-module documentation in Dokka 2: https://kotlinlang.org/docs/dokka-migration.html#update-documentation-aggregation-in-multi-module-projects
* Ensure `navButton` elements are interactable and have proper accessibility properties | ||
* Fixes accessibilty violation: "Ensure all interactive functionality is operable with the keyboard" | ||
*/ | ||
function ensureNavButtonInteractable() { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this built-in in dokka 2?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it was fixed by them, you can pull down the docs and verify it yourself if interested
Issue #
Description of changes
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.