Skip to content

Include links to Scala standard library types in generated Scaladoc #168

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

Merged
merged 1 commit into from
Mar 29, 2021
Merged

Include links to Scala standard library types in generated Scaladoc #168

merged 1 commit into from
Mar 29, 2021

Conversation

xirc
Copy link
Contributor

@xirc xirc commented Mar 25, 2021

Closes #73

sbt provides the autoAPIMappings option.

https://www.scala-sbt.org/1.x/docs/Howto-Scaladoc.html#Enable+automatic+linking+to+the+external+Scaladoc+of+managed+dependencies

Set autoAPIMappings := true for sbt to tell scaladoc where it can find the API documentation for managed dependencies. This requires that dependencies have this information in its metadata and you are using scaladoc for Scala 2.10.2 or later.

Before
before_edited

After
after_edited

@SethTisue
Copy link
Member

LGTM, thank you!

@SethTisue SethTisue merged commit 80eb16b into scala:main Mar 29, 2021
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.

in generated Scaladoc, include links to Scala standard library types
2 participants