From 4d67243c4b6aea2038b160091088ca0998d7be90 Mon Sep 17 00:00:00 2001 From: Felix Mulder Date: Tue, 17 Jan 2017 11:21:02 +0100 Subject: Allow custom project name --- doc-tool/resources/_layouts/api-page.html | 4 ++++ doc-tool/src/dotty/tools/dottydoc/DocDriver.scala | 2 +- doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala | 7 ++++--- doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala | 4 ++-- doc-tool/test/GenDocs.scala | 6 ++++-- doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala | 2 +- 6 files changed, 16 insertions(+), 9 deletions(-) (limited to 'doc-tool') diff --git a/doc-tool/resources/_layouts/api-page.html b/doc-tool/resources/_layouts/api-page.html index e32da6a14..b1140f35e 100644 --- a/doc-tool/resources/_layouts/api-page.html +++ b/doc-tool/resources/_layouts/api-page.html @@ -4,6 +4,10 @@ extraCSS: - css/api-page.css --- + +
diff --git a/doc-tool/src/dotty/tools/dottydoc/DocDriver.scala b/doc-tool/src/dotty/tools/dottydoc/DocDriver.scala index 228366431..0225b3c5e 100644 --- a/doc-tool/src/dotty/tools/dottydoc/DocDriver.scala +++ b/doc-tool/src/dotty/tools/dottydoc/DocDriver.scala @@ -62,7 +62,7 @@ class DocDriver extends Driver { if (!siteRoot.exists || !siteRoot.isDirectory) ctx.error(s"Site root does not exist: $siteRoot") else { - Site(siteRoot, docs) + Site(siteRoot, ctx.settings.projectName.value, docs) .generateApiDocs() .copyStaticFiles() .generateHtmlFiles() diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala index bb28b7a54..d64ebcd90 100644 --- a/doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala +++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala @@ -25,14 +25,15 @@ case class DefaultParams( "site" -> Map( "baseurl" -> site.baseurl, - "posts" -> site.posts.map(_.toMap) + "posts" -> site.posts.map(_.toMap), + "project" -> site.projectTitle ).asJava, "entity" -> entity.asJava() ) def withPosts(posts: Array[BlogPost]): DefaultParams = - copy(site = SiteInfo(site.baseurl, posts)) + copy(site = SiteInfo(site.baseurl, site.projectTitle, posts)) def withUrl(url: String): DefaultParams = copy(page = PageInfo(url)) @@ -46,4 +47,4 @@ case class PageInfo(url: String, date: String = "") { val path: Array[String] = url.split('/').reverse.drop(1) } -case class SiteInfo(baseurl: String, posts: Array[BlogPost]) +case class SiteInfo(baseurl: String, projectTitle: String, posts: Array[BlogPost]) diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala index 92fd95d09..0a8cff347 100644 --- a/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala +++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala @@ -26,7 +26,7 @@ import model.Package import scala.io.Source import scala.collection.mutable.ArrayBuffer -case class Site(val root: JFile, val documentation: Map[String, Package]) extends ResourceFinder { +case class Site(val root: JFile, val projectTitle: String, val documentation: Map[String, Package]) extends ResourceFinder { /** Documentation serialized to java maps */ private val docs: JList[_] = { import model.java._ @@ -122,7 +122,7 @@ case class Site(val root: JFile, val documentation: Map[String, Package]) extend "../" * (assetLen - rootLen - 1 + additionalDepth) + "." } - DefaultParams(docs, PageInfo(pathFromRoot), SiteInfo(baseUrl, Array())) + DefaultParams(docs, PageInfo(pathFromRoot), SiteInfo(baseUrl, projectTitle, Array())) } private def createOutput(outDir: JFile)(op: => Unit): this.type = { diff --git a/doc-tool/test/GenDocs.scala b/doc-tool/test/GenDocs.scala index c60e8f1e0..9a911d4eb 100644 --- a/doc-tool/test/GenDocs.scala +++ b/doc-tool/test/GenDocs.scala @@ -18,6 +18,8 @@ trait LocalResources extends api.scala.Dottydoc { else Array() def withClasspath(files: Array[String]) = + "-siteroot" +: "../docs" +: + "-project" +: "Dotty" +: "-language:Scala2" +: "-classpath" +: "../library/target/scala-2.11/dotty-library_2.11-0.1-SNAPSHOT.jar:../interfaces/target/dotty-interfaces-0.1-SNAPSHOT.jar" +: files @@ -29,7 +31,7 @@ object GenCollections extends LocalResources { val collections = TestWhitelistedCollections.files override def main(args: Array[String]): Unit = - super.main(Array("-siteroot", "../docs") ++ withClasspath(collections.toArray)) + super.main(withClasspath(collections.toArray)) } object GenDottyDocs extends LocalResources { @@ -38,5 +40,5 @@ object GenDottyDocs extends LocalResources { val dottyFiles = new JFile("../compiler/src/dotty").listFiles.flatMap(getFiles).map(_.getAbsolutePath) override def main(args: Array[String]): Unit = - super.main(Array("-siteroot", "../docs") ++ withClasspath(dottyFiles)) + super.main(withClasspath(dottyFiles)) } diff --git a/doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala b/doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala index 11a1da818..bb24eb9fb 100644 --- a/doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala +++ b/doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala @@ -7,7 +7,7 @@ import org.junit.Assert._ class SiteTests extends DottyDocTest { import scala.collection.JavaConverters._ - val site = new Site(new java.io.File("../doc-tool/resources/"), Map.empty) + val site = new Site(new java.io.File("../doc-tool/resources/"), "test-site", Map.empty) private def html( str: String, -- cgit v1.2.3