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

Link to KDoc API documentation from Javadoc overview #31587

Merged
merged 2 commits into from
Nov 10, 2023

Conversation

simonbasle
Copy link
Contributor

This commit also fixes the javadoc task to take the overview.html asset into account, since this is where the link to KDoc is set up.

Note that the output directory for kdoc is changed to be consistent with what's in the docsZip, so that the link works in local builds too.

See gh-28055

This commit also fixes the javadoc task to take the overview.html asset
into account, since this is where the link to KDoc is set up.

Note that the output directory for kdoc is changed to be consistent
with what's in the docsZip, so that the link works in local builds too.

See spring-projectsgh-28055
Copy link
Member

@sbrannen sbrannen left a comment

Choose a reason for hiding this comment

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

I haven't verified that actual result in the build, so I'm trusting that all works.

Otherwise, I think this looks good.

Thanks! 👍

Copy link
Member

@bclozel bclozel left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of this!

@simonbasle simonbasle added this to the 6.1.0 milestone Nov 10, 2023
@simonbasle simonbasle added type: documentation A documentation task type: task A general task labels Nov 10, 2023
@simonbasle simonbasle self-assigned this Nov 10, 2023
@simonbasle simonbasle merged commit a97ecf7 into spring-projects:main Nov 10, 2023
4 checks passed
@simonbasle simonbasle deleted the javadocLinkToKdoc branch November 10, 2023 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task type: task A general task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants