-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #77 from jonas/fix-scaladoc-directive
Fix the scaladoc directive to work for Scala 2.12
- Loading branch information
Showing
8 changed files
with
30 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,14 @@ | ||
### Fixes and enhancements | ||
|
||
- Source url. See below. [#69][69] by [@jonas][@jonas] and [@gsechaud][@gsechaud] | ||
- Fix `@scaladoc` to work for Scala 2.12. [#77][77] by [@jonas][@jonas] | ||
|
||
### Source origin url on GitHub | ||
|
||
`$page.source_url$` contains the plain text of the github source url of the current page. Works only if the associated `github.base_url` is defined. If it doesn't, this field returns a null value; then a condition testing like `$if(page.source_url)$` would be necessary in this case. | ||
Provide a new template "sourc.st" available in the generic theme which allows to display a simple plain text with the link associated to the current file. | ||
Provide a new template "source.st" available in the generic theme which allows to display a simple plain text with the link associated to the current file. | ||
|
||
[69]: https://github.com/lightbend/paradox/pull/69 | ||
[69]: https://github.com/lightbend/paradox/pull/69 | ||
[77]: https://github.com/lightbend/paradox/pull/77 | ||
[@gsechaud]: https://github.com/gsechaud | ||
[@jonas]: https://github.com/jonas |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
val akkaVersion = "2.4.13" | ||
val akkaHttpVersion = "10.0.0" | ||
|
||
version := "0.1.0" | ||
scalaVersion := "2.12.1" | ||
|
||
enablePlugins(ParadoxPlugin) | ||
paradoxTheme := None | ||
paradoxProperties in Compile ++= Map( | ||
"scaladoc.akka.base_url" -> s"http://doc.akka.io/api/akka/$akkaVersion", | ||
"scaladoc.akka.http.base_url" -> s"http://doc.akka.io/api/akka-http/$akkaHttpVersion" | ||
) |
2 changes: 2 additions & 0 deletions
2
plugin/src/sbt-test/paradox/scaladoc-2.12/expected/scaladoc-2.12.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<p>Use a <a href="http://www.scala-lang.org/api/2.12.1/scala/concurrent/Future.html">Future</a> to avoid that long running operations block the <a href="http://doc.akka.io/api/akka/2.4.13/akka/actor/Actor.html">Actor</a>.</p> | ||
<p><a href="http://doc.akka.io/api/akka-http/10.0.0/akka/http/scaladsl/Http$.html">Http</a></p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % sys.props("project.version")) |
1 change: 1 addition & 0 deletions
1
plugin/src/sbt-test/paradox/scaladoc-2.12/src/main/paradox/_template/page.st
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
$page.content$ |
3 changes: 3 additions & 0 deletions
3
plugin/src/sbt-test/paradox/scaladoc-2.12/src/main/paradox/scaladoc-2.12.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Use a @scaladoc:[Future](scala.concurrent.Future) to avoid that long running operations block the @scaladoc:[Actor](akka.actor.Actor). | ||
|
||
@scaladoc:[Http](akka.http.scaladsl.Http$) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
> paradox | ||
|
||
$ must-mirror target/paradox/site/scaladoc-2.12.html expected/scaladoc-2.12.html |