diff --git a/project/Docs.scala b/project/Docs.scala index 42f4d4303..68e459f8b 100644 --- a/project/Docs.scala +++ b/project/Docs.scala @@ -12,10 +12,16 @@ object Docs { val cnameFile = SettingKey[File]("cname-file", "Location of the CNAME file for the website.") + val SnapshotPath = "snapshot" + val ReleasePath = "release" + val DocsPath = "docs" + val IndexHtml = "index.html" + val HomeHtml = "home.html" + val VersionPattern = """(\d+)\.(\d+)\.(\d+)(-.+)?""".r.pattern def settings: Seq[Setting[_]] = site.settings ++ - site.sphinxSupport("docs") ++ + site.sphinxSupport(DocsPath) ++ site.includeScaladoc("api") ++ siteIncludeSxr("sxr") ++ ghPagesSettings @@ -41,10 +47,25 @@ object Docs IO.copy(mappings map { case (file, target) => (file, versioned / target) }) IO.copyFile(cname, repo / cname.getName) IO.touch(repo / ".nojekyll") - linkSite(repo, v, if(snap) "snapshot" else "release", s.log) + IO.write(repo / "versions.js", versionsJs(sortVersions(collectVersions(repo)))) + if(!snap) + RootIndex(versioned / DocsPath / "home.html", repo / IndexHtml) + linkSite(repo, v, if(snap) SnapshotPath else ReleasePath, s.log) s.log.info("Copied site to " + versioned) repo } + def versionsJs(vs: Seq[String]): String = "var availableDocumentationVersions = " + vs.mkString("['", "', '", "']") + // names of all directories that are explicit versions + def collectVersions(base: File): Seq[String] = (base * versionFilter).get.map(_.getName) + def sortVersions(vs: Seq[String]): Seq[String] = vs.sortBy(versionComponents).reverse + def versionComponents(v: String): Option[(Int,Int,Int,Option[String])] = { + val m = VersionPattern.matcher(v) + if(m.matches()) + Some( (m.group(1).toInt, m.group(2).toInt, m.group(3).toInt, Option(m.group(4))) ) + else + None + } + def versionFilter = new PatternFilter(VersionPattern) && DirectoryFilter def linkSite(base: File, to: String, from: String, log: Logger) { val current = base / to @@ -60,4 +81,42 @@ object Docs case 0 => () case code => error("Could not create symbolic link '" + file.getAbsolutePath + "' with path " + path) } +} +object RootIndex +{ + import Docs._ + import org.jsoup._ + + def apply(versionIndex: File, to: File) + { + val doc = Jsoup.parse(versionIndex, "UTF-8") + rewriteLinks(doc) + removeSearch(doc) + IO.write(to, doc.outerHtml) + } + def retargetIndexLink(original: String): String = + if(isAbsolute(original) || original.startsWith("#")) + original + else + ReleasePath + "/docs/" + original + + def isAbsolute(s: String): Boolean = (new java.net.URI(s)).isAbsolute + + def rewriteLinks(doc: nodes.Document) + { + rewriteLinks(doc, "*", "href") + rewriteLinks(doc, "script", "src") + } + def rewriteLinks(doc: nodes.Document, elemName: String, attrName: String): Unit = + for(elem <- select(doc, elemName + "[" + attrName + "]")) + elem.attr(attrName, retargetIndexLink(elem.attr(attrName))) + + def removeSearch(doc: nodes.Document): Unit = + doc.select(".search").remove() + + def select(doc: nodes.Document, s: String) = + { + import collection.JavaConverters._ + doc.select(s).iterator.asScala + } } \ No newline at end of file diff --git a/project/p.sbt b/project/p.sbt index d40b6fca8..7e437e8f5 100644 --- a/project/p.sbt +++ b/project/p.sbt @@ -1,4 +1,7 @@ -libraryDependencies += "net.databinder" %% "dispatch-http" % "0.8.8" +libraryDependencies ++= Seq( + "net.databinder" %% "dispatch-http" % "0.8.8", + "org.jsoup" % "jsoup" % "1.7.1" +) addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.6.0") diff --git a/src/sphinx/_sphinx/themes/sbt/layout.html b/src/sphinx/_sphinx/themes/sbt/layout.html index 083307619..453f8467f 100644 --- a/src/sphinx/_sphinx/themes/sbt/layout.html +++ b/src/sphinx/_sphinx/themes/sbt/layout.html @@ -6,6 +6,8 @@ {% extends "basic/layout.html" %} +{% set script_files = script_files + ['../../versions.js'] %} +{% set script_files = script_files + ['_static/set-versions.js'] %} {% set css_files = css_files + ['_static/base.css'] %} {% set css_files = css_files + ['_static/docs.css'] %} @@ -73,7 +75,7 @@ {%- endif %}