Add dottydoc setting -project-logo

Author: TheElectronWill

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

@@ -200,6 +200,13 @@ class ScalaSettings extends Settings.SettingGroup {
     "The source repository of your project",
     ""
   )
+  
+  val projectLogo: Setting[String] = StringSetting(
+    "-project-logo",
+    "project logo filename",
+    "The file that contains the project's logo (in /images)",
+    ""
+  )
 
   val wikiSyntax: Setting[Boolean] = BooleanSetting("-Xwiki-syntax", "Retains the Scala2 behavior of using Wiki Syntax in Scaladoc")
 }

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

@@ -42,13 +42,14 @@ class DocDriver extends Driver {
     val projectName = ctx.settings.projectName.value
     val projectVersion = ctx.settings.projectVersion.value
     val projectUrl = ctx.settings.projectUrl.value
+    val projectLogo = ctx.settings.projectLogo.value
 
     if (projectName.isEmpty)
       ctx.error(s"Site project name not set. Use `-project <title>` to set the project name")
     else if (!siteRoot.exists || !siteRoot.isDirectory)
       ctx.error(s"Site root does not exist: $siteRoot")
     else {
-      Site(siteRoot, projectName, projectVersion, projectUrl, ctx.docbase.packages)
+      Site(siteRoot, projectName, projectVersion, projectUrl, projectLogo, ctx.docbase.packages)
         .generateApiDocs()
         .copyStaticFiles()
         .generateHtmlFiles()

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

@@ -40,6 +40,7 @@ case class DefaultParams(
         "project" -> site.projectTitle,
         "version" -> site.projectVersion,
         "projectUrl" -> site.projectUrl,
+        "logo" -> site.projectLogo,
         "root" -> site.root
       ).asJava,
 
@@ -56,7 +57,8 @@ case class DefaultParams(
 
   def withPosts(posts: Array[BlogPost]): DefaultParams =
     copy(site = SiteInfo(
-      site.baseurl, site.projectTitle, site.projectVersion, site.projectUrl, posts, site.root))
+      site.baseurl, site.projectTitle, site.projectVersion, site.projectUrl, site.projectLogo,
+      posts, site.root))
 
   def withUrl(url: String): DefaultParams =
     copy(page = PageInfo(url))
@@ -75,6 +77,7 @@ case class SiteInfo(
   projectTitle: String,
   projectVersion: String,
   projectUrl: String,
+  projectLogo: String,
   posts: Array[BlogPost],
   root: String
 )

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

@@ -34,6 +34,7 @@ case class Site(
   projectTitle: String,
   projectVersion: String,
   projectUrl: String,
+  projectLogo: String,
   documentation: Map[String, Package]
 ) extends ResourceFinder {
   /** Documentation serialized to java maps */
@@ -178,7 +179,7 @@ case class Site(
     DefaultParams(
       docs, docsFlattened, documentation, PageInfo(pathFromRoot),
       SiteInfo(
-        baseUrl, projectTitle, projectVersion, projectUrl, Array(),
+        baseUrl, projectTitle, projectVersion, projectUrl, projectLogo, Array(),
         root.toString
       ),
       sidebar

project/Build.scala

@@ -382,6 +382,7 @@ object Build {
         "-project", "Dotty",
         "-project-version", dottyVersion,
         "-project-url", dottyGithubUrl,
+        "-project-logo", "dotty-logo.svg",
         "-classpath", dottydocClasspath.value
       )
       (runMain in Compile).toTask(