Skip to content

Commit 4d67243

Browse files
committed
Allow custom project name
1 parent fb8854a commit 4d67243

File tree

7 files changed

+21
-14
lines changed

7 files changed

+21
-14
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -220,11 +220,11 @@ class ScalaSettings extends Settings.SettingGroup {
220220
sys.props("user.dir")
221221
)
222222

223-
val DocTitle = StringSetting (
224-
"-Ydoc-title",
225-
"title",
226-
"The overall name of the Scaladoc site",
227-
""
223+
val projectName = StringSetting (
224+
"-project",
225+
"project title",
226+
"The name of the project",
227+
sys.props("user.dir").split(sys.props("file.separator")).last
228228
)
229229

230230
val DocVersion = StringSetting (

doc-tool/resources/_layouts/api-page.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
- css/api-page.css
55
---
66

7+
<script>
8+
document.title = "{{ site.project }} API - {{ entity.name }}"
9+
</script>
10+
711
<div id="entity-container">
812
<div id="entity-title">
913
<span id="entity-modifiers">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class DocDriver extends Driver {
6262
if (!siteRoot.exists || !siteRoot.isDirectory)
6363
ctx.error(s"Site root does not exist: $siteRoot")
6464
else {
65-
Site(siteRoot, docs)
65+
Site(siteRoot, ctx.settings.projectName.value, docs)
6666
.generateApiDocs()
6767
.copyStaticFiles()
6868
.generateHtmlFiles()

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,15 @@ case class DefaultParams(
2525

2626
"site" -> Map(
2727
"baseurl" -> site.baseurl,
28-
"posts" -> site.posts.map(_.toMap)
28+
"posts" -> site.posts.map(_.toMap),
29+
"project" -> site.projectTitle
2930
).asJava,
3031

3132
"entity" -> entity.asJava()
3233
)
3334

3435
def withPosts(posts: Array[BlogPost]): DefaultParams =
35-
copy(site = SiteInfo(site.baseurl, posts))
36+
copy(site = SiteInfo(site.baseurl, site.projectTitle, posts))
3637

3738
def withUrl(url: String): DefaultParams =
3839
copy(page = PageInfo(url))
@@ -46,4 +47,4 @@ case class PageInfo(url: String, date: String = "") {
4647
val path: Array[String] = url.split('/').reverse.drop(1)
4748
}
4849

49-
case class SiteInfo(baseurl: String, posts: Array[BlogPost])
50+
case class SiteInfo(baseurl: String, projectTitle: String, posts: Array[BlogPost])

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import model.Package
2626
import scala.io.Source
2727
import scala.collection.mutable.ArrayBuffer
2828

29-
case class Site(val root: JFile, val documentation: Map[String, Package]) extends ResourceFinder {
29+
case class Site(val root: JFile, val projectTitle: String, val documentation: Map[String, Package]) extends ResourceFinder {
3030
/** Documentation serialized to java maps */
3131
private val docs: JList[_] = {
3232
import model.java._
@@ -122,7 +122,7 @@ case class Site(val root: JFile, val documentation: Map[String, Package]) extend
122122
"../" * (assetLen - rootLen - 1 + additionalDepth) + "."
123123
}
124124

125-
DefaultParams(docs, PageInfo(pathFromRoot), SiteInfo(baseUrl, Array()))
125+
DefaultParams(docs, PageInfo(pathFromRoot), SiteInfo(baseUrl, projectTitle, Array()))
126126
}
127127

128128
private def createOutput(outDir: JFile)(op: => Unit): this.type = {

doc-tool/test/GenDocs.scala

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ trait LocalResources extends api.scala.Dottydoc {
1818
else Array()
1919

2020
def withClasspath(files: Array[String]) =
21+
"-siteroot" +: "../docs" +:
22+
"-project" +: "Dotty" +:
2123
"-language:Scala2" +:
2224
"-classpath" +: "../library/target/scala-2.11/dotty-library_2.11-0.1-SNAPSHOT.jar:../interfaces/target/dotty-interfaces-0.1-SNAPSHOT.jar" +:
2325
files
@@ -29,7 +31,7 @@ object GenCollections extends LocalResources {
2931
val collections = TestWhitelistedCollections.files
3032

3133
override def main(args: Array[String]): Unit =
32-
super.main(Array("-siteroot", "../docs") ++ withClasspath(collections.toArray))
34+
super.main(withClasspath(collections.toArray))
3335
}
3436

3537
object GenDottyDocs extends LocalResources {
@@ -38,5 +40,5 @@ object GenDottyDocs extends LocalResources {
3840
val dottyFiles = new JFile("../compiler/src/dotty").listFiles.flatMap(getFiles).map(_.getAbsolutePath)
3941

4042
override def main(args: Array[String]): Unit =
41-
super.main(Array("-siteroot", "../docs") ++ withClasspath(dottyFiles))
43+
super.main(withClasspath(dottyFiles))
4244
}

doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import org.junit.Assert._
77

88
class SiteTests extends DottyDocTest {
99
import scala.collection.JavaConverters._
10-
val site = new Site(new java.io.File("../doc-tool/resources/"), Map.empty)
10+
val site = new Site(new java.io.File("../doc-tool/resources/"), "test-site", Map.empty)
1111

1212
private def html(
1313
str: String,

0 commit comments

Comments
 (0)