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

Jump to bottom

Add <info.apiURL> section to published pom.xml for auto-scaladoc linking in sbt #7201

Closed
scabug opened this issue Mar 1, 2013 · 4 comments
Closed

Add <info.apiURL> section to published pom.xml for auto-scaladoc linking in sbt #7201

scabug opened this issue Mar 1, 2013 · 4 comments
Assignees
@adriaanm
Labels
build enhancement
Milestone
2.10.2-RC1

Comments

@scabug
Copy link

scabug commented Mar 1, 2013 •
edited by retronym

sbt 0.13 will be able to automatically configure scaladoc to link to external sites (via #191) for managed dependencies if those dependencies have a particular property in their pom.xml. This property name is info.apiURL and its value should be the base URL for the API docs for that module version.

So, the pom.xml for scala-library should have a section like:

<properties>
    <info.apiURL>http://www.scala-lang.org/api/2.10.0/</info.apiURL>
</properties>
@scabug
Copy link
Author

scabug commented Mar 1, 2013

Imported From: https://issues.scala-lang.org/browse/SI-7201?orig=1
Reporter: @harrah

@scabug
Copy link
Author

scabug commented May 14, 2013

@harrah said:
This would be good to have for 2.10.2 so when sbt 0.13.0 is out, projects can auto-link their API docs to the Scala library's API docs. It will also help to verify that the feature works on the library every Scala project uses.

@scabug
Copy link
Author

scabug commented May 14, 2013

@adriaanm said:
Josh, please assign to me if you run out of time. Happy to do it.

@scabug
Copy link
Author

scabug commented May 15, 2013

@adriaanm said:
scala/scala#2540

@scabug scabug closed this as completed May 17, 2013
@scabug scabug added this to the 2.10.2-RC1 milestone Apr 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adriaanm adriaanm

Labels
build enhancement
Projects
None yet
Milestone
2.10.2-RC1
Development

No branches or pull requests
2 participants
@adriaanm @scabug