Skip to content

Commit 6ca3c3d

Browse files
committed
Improve parser combinator documentation
* Links to scala-lang.org/api/... for types from the Scala library * Diagrams (if graphviz is around) * Links to the source on GitHub (only for released versions) * Html pages didn't even a title, they do now
1 parent d118db9 commit 6ca3c3d

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

Diff for: .travis.yml

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
language: scala
22

3+
addons:
4+
apt:
5+
packages:
6+
- graphviz
7+
38
before_install:
49
- cat /etc/hosts # optionally check the content *before*
510
- sudo hostname "$(hostname | cut -c1-63)"

Diff for: build.sbt

+14-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,20 @@ crossScalaVersions in ThisBuild := {
2323
lazy val `scala-parser-combinators` = crossProject.in(file(".")).
2424
settings(scalaModuleSettings: _*).
2525
settings(
26-
name := "scala-parser-combinators-root"
26+
name := "scala-parser-combinators-root",
27+
apiMappings += (scalaInstance.value.libraryJar ->
28+
url(s"https://www.scala-lang.org/api/${scalaVersion.value}/")),
29+
scalacOptions in (Compile, doc) ++= Seq(
30+
"-diagrams",
31+
"-doc-source-url",
32+
s"https://github.com/scala/scala-parser-combinators/tree/v${version.value}€{FILE_PATH}.scala",
33+
"-sourcepath",
34+
(baseDirectory in LocalRootProject).value.absolutePath,
35+
"-doc-title",
36+
"Scala Parser Combinators",
37+
"-doc-version",
38+
version.value
39+
)
2740
).
2841
jvmSettings(
2942
// Mima uses the name of the jvm project in the artifactId

0 commit comments

Comments
 (0)