Skip to content

Commit 3843ba7

Browse files
authored
No javadoc please; document new feature (#65)
2 parents 235a1a2 + 7da14c2 commit 3843ba7

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,15 @@ import com.lightbend.paradox.apidoc.ApidocPlugin.autoImport.apidocRootPackage
3535
(...)
3636
```
3737

38+
### When only Scaladoc is generated
39+
40+
If the project does not publish Javadoc, the corresponding Javadoc base URL can be cleared and the Java links will point to the `javadsl` package in the Scaladocs.
41+
42+
Example:
43+
```scala
44+
"javadoc.akka.stream.alpakka.base_url" -> ""
45+
```
46+
3847
## License
3948

4049
The license is Apache 2.0, see LICENSE.

build.sbt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ libraryDependencies ++= Seq(
1414
Library.scalatest % Test
1515
)
1616

17-
licenses += ("Apache-2.0", url("http://www.apache.org/licenses/LICENSE-2.0"))
17+
licenses += ("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0"))
1818
homepage := Some(url("https://github.com/lightbend/sbt-paradox-apidoc"))
1919
scmInfo := Some(
2020
ScmInfo(url("https://github.com/lightbend/sbt-paradox-apidoc"), "git@github.com:lightbend/sbt-paradox-apidoc.git")
@@ -25,8 +25,9 @@ developers += Developer(
2525
"https://gitter.im/lightbend/paradox",
2626
url("https://github.com/lightbend/sbt-paradox-apidoc/graphs/contributors")
2727
)
28-
organizationName := "Lightbend Inc."
29-
startYear := Some(2018)
28+
organizationName := "Lightbend Inc."
29+
organizationHomepage := Some(url("https://lightbend.com"))
30+
startYear := Some(2018)
3031

3132
bintrayOrganization := Some("sbt")
3233
bintrayRepository := "sbt-plugin-releases"
@@ -39,3 +40,5 @@ scriptedLaunchOpts += ("-Dproject.version=" + version.value)
3940
scriptedLaunchOpts ++= java.lang.management.ManagementFactory.getRuntimeMXBean.getInputArguments.asScala.filter(
4041
a => Seq("-Xmx", "-Xms", "-XX", "-Dfile").exists(a.startsWith)
4142
)
43+
44+
packageSrc / publishArtifact := false

0 commit comments

Comments
 (0)