Add project-url to settings for dottydoc

Author: felixmulder

compiler/src/dotty/tools/dotc/config/ScalaSettings.scala

@@ -130,5 +130,12 @@ class ScalaSettings extends Settings.SettingGroup {
     ""
   )
 
+  val projectUrl = StringSetting (
+    "-project-url",
+    "project repository homepage",
+    "The source repository of your project",
+    ""
+  )
+
   val wikiSyntax = BooleanSetting("-Xwiki-syntax", "Retains the Scala2 behavior of using Wiki Syntax in Scaladoc")
 }

doc-tool/resources/_includes/toolbar.html

@@ -6,4 +6,14 @@
         <h1 id="project-name">{{ site.project }} Documentation</h1>
         <h2 id="project-version">{{ site.version }}</h2>
     </div>
+
+    {% if site.projectUrl %}
+    <a title="Project repository" id="github-link" href="{{ site.projectUrl }}">
+        {% if site.projectUrl contains "github" %}
+        <i class="fa fa-github" aria-hidden="true"></i>
+        {% else %}
+        <i class="fa fa-code" aria-hidden="true"></i>
+        {% endif %}
+    </a>
+    {% endif %}
 </div>

doc-tool/resources/_layouts/main.html

@@ -19,7 +19,7 @@
 
         <link
             rel="stylesheet"
-            href="{{ site.baseurl }}/css/font-awesome.min.css"
+            href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"
         >
 
         <link

doc-tool/resources/css/toolbar.css

@@ -54,3 +54,10 @@ div#toolbar > div#project-details > h2#project-version {
   margin-left: 1px;
 }
 
+div#toolbar > a#github-link {
+  color: #fff;
+  position: absolute;
+  top: 7px;
+  right: 15px;
+  font-size: 40px;
+}

doc-tool/src/dotty/tools/dottydoc/DocDriver.scala

@@ -46,11 +46,12 @@ class DocDriver extends Driver {
     val siteRoot = new java.io.File(ctx.settings.siteRoot.value)
     val projectName = ctx.settings.projectName.value
     val projectVersion = ctx.settings.projectVersion.value
+    val projectUrl = ctx.settings.projectUrl.value
 
     if (!siteRoot.exists || !siteRoot.isDirectory)
       ctx.error(s"Site root does not exist: $siteRoot")
     else {
-      Site(siteRoot, projectName, projectVersion, ctx.docbase.packages)
+      Site(siteRoot, projectName, projectVersion, projectUrl, ctx.docbase.packages)
         .generateApiDocs()
         .copyStaticFiles()
         .generateHtmlFiles()

doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala

@@ -35,7 +35,8 @@ case class DefaultParams(
         "baseurl" -> site.baseurl,
         "posts" -> site.posts.map(_.toMap),
         "project" -> site.projectTitle,
-        "version" -> site.projectVersion
+        "version" -> site.projectVersion,
+        "projectUrl" -> site.projectUrl
       ).asJava,
 
       "sidebar" -> sidebar.titles.asJava
@@ -50,7 +51,8 @@ case class DefaultParams(
   }
 
   def withPosts(posts: Array[BlogPost]): DefaultParams =
-    copy(site = SiteInfo(site.baseurl, site.projectTitle, site.projectVersion, posts))
+    copy(site = SiteInfo(
+      site.baseurl, site.projectTitle, site.projectVersion, site.projectUrl, posts))
 
   def withUrl(url: String): DefaultParams =
     copy(page = PageInfo(url))
@@ -68,6 +70,7 @@ case class SiteInfo(
   baseurl: String,
   projectTitle: String,
   projectVersion: String,
+  projectUrl: String,
   posts: Array[BlogPost]
 )
 

doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala

@@ -28,7 +28,13 @@ import io.{ AbstractFile, VirtualFile, File }
 import scala.collection.mutable.ArrayBuffer
 import util.syntax._
 
-case class Site(val root: JFile, val projectTitle: String, val projectVersion: String, val documentation: Map[String, Package]) extends ResourceFinder {
+case class Site(
+  val root: JFile,
+  val projectTitle: String,
+  val projectVersion: String,
+  val projectUrl: String,
+  val documentation: Map[String, Package]
+) extends ResourceFinder {
   /** Documentation serialized to java maps */
   private val docs: JList[_] = {
     import model.JavaConverters._
@@ -157,7 +163,11 @@ case class Site(val root: JFile, val projectTitle: String, val projectVersion: S
       "../" * (assetLen - rootLen - 1 + additionalDepth) + "."
     }
 
-    DefaultParams(docs, documentation, PageInfo(pathFromRoot), SiteInfo(baseUrl, projectTitle, projectVersion, Array()), sidebar)
+    DefaultParams(
+      docs, documentation, PageInfo(pathFromRoot),
+      SiteInfo(baseUrl, projectTitle, projectVersion, projectUrl, Array()),
+      sidebar
+    )
   }
 
   /* Creates output directories if allowed */

project/Build.scala

@@ -27,6 +27,7 @@ object Build {
   val scalacVersion = "2.11.11" // Do not rename, this is grepped in bin/common.
 
   val dottyOrganization = "ch.epfl.lamp"
+  val dottyGithubUrl = "https://github.com/lampepfl/dotty"
   val dottyVersion = {
     val baseVersion = "0.1.1"
     val isNightly = sys.env.get("NIGHTLYBUILD") == Some("yes")
@@ -86,7 +87,7 @@ object Build {
     organization := dottyOrganization,
     organizationName := "LAMP/EPFL",
     organizationHomepage := Some(url("http://lamp.epfl.ch")),
-    homepage := Some(url("https://github.com/lampepfl/dotty")),
+    homepage := Some(url(dottyGithubUrl)),
 
     scalacOptions ++= Seq(
       "-feature",
@@ -283,6 +284,7 @@ object Build {
         "-siteroot", "docs",
         "-project", "Dotty",
         "-project-version", dottyVersion,
+        "-project-url", dottyGithubUrl,
         "-classpath", s"$dottyLib:$dottyInterfaces:$otherDeps"
       )
         (runMain in Compile).toTask(
@@ -887,12 +889,12 @@ object DottyInjectedPlugin extends AutoPlugin {
          Some("releases"  at nexus + "service/local/staging/deploy/maven2")
      },
      publishArtifact in Test := false,
-     homepage := Some(url("https://github.com/lampepfl/dotty")),
+     homepage := Some(url(dottyGithubUrl)),
      licenses += ("BSD New",
-       url("https://github.com/lampepfl/dotty/blob/master/LICENSE.md")),
+       url("$dottyGithubUrl/blob/master/LICENSE.md")),
      scmInfo := Some(
        ScmInfo(
-         url("https://github.com/lampepfl/dotty"),
+         url(dottyGithubUrl),
          "scm:git:[email protected]:lampepfl/dotty.git"
        )
      ),