Merge branch 'release/v1.4.0'

.travis.yml

@@ -11,7 +11,6 @@ dist: trusty
 jdk: oraclejdk8
 matrix:
   include:
-  - env: SBT_CROSS_VERSION="0.13.17"
   - env: SBT_CROSS_VERSION="1.1.6"
 
 addons:
@@ -63,5 +62,5 @@ deploy:
   skip_cleanup: true
   on:
     tags: true
-    condition: $TRAVIS_PULL_REQUEST = false && $SBT_CROSS_VERSION = 0.13*
+    condition: $TRAVIS_PULL_REQUEST = false && $SBT_CROSS_VERSION = 1.1*
 #travis-deploy

build.sbt

@@ -6,9 +6,13 @@ enablePlugins(SbtPlugin)
 name := "sbt-site"
 
 organization := "com.typesafe.sbt"
+organizationName := "sbt"
+organizationHomepage := Some(url("https://www.scala-sbt.org/"))
 
-version := "1.3.3"
-crossSbtVersions := List("0.13.17", "1.1.6")
+homepage := Some(url("https://www.scala-sbt.org/sbt-site/"))
+
+version := "1.4.0"
+crossSbtVersions := List("1.1.6")
 
 licenses += ("BSD 3-Clause", url("https://opensource.org/licenses/BSD-3-Clause"))
 //#scm-info
@@ -26,44 +30,31 @@ libraryDependencies ++= Seq(
   "ws.unfiltered"  %% "unfiltered-filter" % unfilteredVersion,
   "ws.unfiltered"  %% "unfiltered-jetty" % unfilteredVersion,
   "ws.unfiltered"  %% "unfiltered-specs2" % unfilteredVersion % "test",
-  "org.foundweekends" %% "pamflet-library" % "0.7.1",
-  "org.yaml"        % "snakeyaml"        % "1.13",
-  "com.typesafe"    % "config"           % "1.2.1", // Last version to support Java 1.6
-  "org.asciidoctor" % "asciidoctorj"     % "1.5.4.1",
-  "org.asciidoctor" % "asciidoctorj-diagram" % "1.5.4.1"
+  "org.foundweekends" %% "pamflet-library" % "0.8.0",
+  "org.yaml"        % "snakeyaml"        % "1.24",
+  "com.typesafe"    % "config"           % "1.3.4",
+  "org.asciidoctor" % "asciidoctorj"     % "1.6.2",
+  "org.asciidoctor" % "asciidoctorj-diagram" % "1.5.16"
 )
 
-addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.3.2")
-
-libraryDependencies ++= {
-  if ((sbtBinaryVersion in pluginCrossBuild).value == "0.13") {
-    Seq(
-      Defaults.sbtPluginExtra(
-        "org.planet42" % "laika-sbt" % "0.7.0",
-        (sbtBinaryVersion in pluginCrossBuild).value,
-        (scalaBinaryVersion in pluginCrossBuild).value
-      )
-    )
-  } else {
-    Seq(
-      Defaults.sbtPluginExtra(
-        "org.planet42" % "laika-sbt" % "0.8.0",
-        (sbtBinaryVersion in pluginCrossBuild).value,
-        (scalaBinaryVersion in pluginCrossBuild).value
-      )
-    )
-  }
-}
+addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.5.5")
+
+libraryDependencies +=
+  Defaults.sbtPluginExtra(
+    "org.planet42" % "laika-sbt" % "0.8.0",
+    (sbtBinaryVersion in pluginCrossBuild).value,
+    (scalaBinaryVersion in pluginCrossBuild).value
+  )
 
 enablePlugins(ParadoxSitePlugin, ParadoxMaterialThemePlugin)
-sourceDirectory in Paradox := sourceDirectory.value / "main" / "paradox"
+Paradox / sourceDirectory := sourceDirectory.value / "main" / "paradox"
 ParadoxMaterialThemePlugin.paradoxMaterialThemeSettings(Paradox)
-paradoxMaterialTheme in Paradox ~= {
+Paradox / paradoxMaterialTheme ~= {
   _.withFavicon("img/favicon.png")
    .withLogo("img/sbt-logo.svg")
    .withRepository(uri("https://github.com/sbt/sbt-site"))
 }
-version in Paradox := {
+Paradox / version := {
   if (isSnapshot.value) "git tag -l".!!.split("\r?\n").last.substring(1)
   else version.value
 }
@@ -74,7 +65,7 @@ git.remoteRepo := scmInfo.value.get.connection.replace("scm:git:", "")
 //#ghpages-publish
 
 TaskKey[Unit]("runScriptedTest") := Def.taskDyn {
-  val sbtBinVersion = (sbtBinaryVersion in pluginCrossBuild).value
+  val sbtBinVersion = (pluginCrossBuild / sbtBinaryVersion).value
   val base = sbtTestDirectory.value
 
   def isCompatible(directory: File): Boolean = {

project/plugins.sbt

@@ -1,7 +1,7 @@
-addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.4")
-addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.2")
+addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.5")
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.3")
 //#sbt-ghpages
-addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.2")
+addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.3")
 //#sbt-ghpages
 addSbtPlugin("io.github.jonas" % "sbt-paradox-material-theme" % "0.6.0")
 

src/main/paradox/advanced-usage.md

@@ -6,6 +6,6 @@ Here are listed examples of a more advanced usage.
 
 If you need to run a generator on more than one source directory, bypassing the `AutoPlugin` system and defining one or more sbt `Configuration`s is necessary. For example, suppose you have two Paradox source directories and want them each generated as a subdirectory under `target/site`. A `build.sbt` might look something like this:
 
-@@ snip[advanced-usage](../../sbt-test/site/can-run-generator-twice/build.sbt) { #advanced-usage }
+@@ snip[advanced-usage](/src/sbt-test/site/can-run-generator-twice/build.sbt) { #advanced-usage }
 
 The other generators follow a similar pattern, e.g. `JekyllPlugin.jekyllSettings(config("foo"))`.

src/main/paradox/api-documentation.md

@@ -4,17 +4,17 @@
 
 To include Scaladoc with your site, add the following line to your `build.sbt`:
 
-@@ snip[enablePlugin](../../sbt-test/scaladoc/can-add-scaladoc/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/scaladoc/can-add-scaladoc/build.sbt) { #enablePlugin }
 
 This will default to putting the Scaladoc under the `latest/api` directory on the website. You can change this with the `siteSubdirName` key in the `SiteScaladoc` scope:
 
-@@ snip[siteSubdirName](../../sbt-test/scaladoc/can-add-scaladoc/build.sbt) { #siteSubdirName }
+@@ snip[siteSubdirName](/src/sbt-test/scaladoc/can-add-scaladoc/build.sbt) { #siteSubdirName }
 
 ## Aggregating API documentation with sbt-unidoc
 
 [sbt-unidoc] allows to aggregate Scaladoc or Javadoc from sub-projects into a unified view. The following example shows how you can add aggregated Scaladoc to your site:
 
-@@ snip[unidoc-site](../../sbt-test/scaladoc/can-aggregate/build.sbt) { #subprojects #unidoc-site }
+@@ snip[unidoc-site](/src/sbt-test/scaladoc/can-aggregate/build.sbt) { #subprojects #unidoc-site }
 
 [sbt-unidoc]: https://github.com/sbt/sbt-unidoc
 
@@ -24,8 +24,8 @@ In case you want to include the Scaladoc separate for each sub-product there are
 you only have a few sub-projects the simplest solution is to manually include
 the scaladoc for each project:
 
-@@ snip[scaladoc-site](../../sbt-test/scaladoc/can-aggregate/build.sbt) { #subprojects #scaladoc-site }
+@@ snip[scaladoc-site](/src/sbt-test/scaladoc/can-aggregate/build.sbt) { #subprojects #scaladoc-site }
 
 For projects with many such sub-projects, a more maintainable approach is to configure it in a more programatic way:
 
-@@ snip[scaladoc-site-alternative](../../sbt-test/scaladoc/can-aggregate/build.sbt) { #subprojects #scaladoc-site-alternative }
+@@ snip[scaladoc-site-alternative](/src/sbt-test/scaladoc/can-aggregate/build.sbt) { #subprojects #scaladoc-site-alternative }

src/main/paradox/generators/asciidoctor.md

@@ -2,16 +2,16 @@
 
 The sbt-site plugin has direct support for building [Asciidoctor] projects. To enable Asciidoctor site generation, simply enable the associated plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/asciidoctor/can-use-asciidoctor/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/asciidoctor/can-use-asciidoctor/build.sbt) { #enablePlugin }
 
 This assumes you have an Asciidoctor project under the `src/asciidoctor` directory. To change this, set the `sourceDirectory` key in the `Asciidoctor` scope:
 
 ```sbt
-sourceDirectory in Asciidoctor := sourceDirectory.value / "asciimd"
+Asciidoctor / sourceDirectory := sourceDirectory.value / "asciimd"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Asciidoctor` scope:
 
-@@ snip[siteSubdirName](../../../sbt-test/asciidoctor/can-use-asciidoctor/build.sbt) { #siteSubdirName }
+@@ snip[siteSubdirName](/src/sbt-test/asciidoctor/can-use-asciidoctor/build.sbt) { #siteSubdirName }
 
 [Asciidoctor]: http://asciidoctor.org

src/main/paradox/generators/gitbook.md

@@ -2,20 +2,20 @@
 
 The sbt-site plugin has direct support for building [GitBook] projects. To enable GitBook site generation, simply enable the associated plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/gitbook/ignore-dot-files/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/gitbook/ignore-dot-files/build.sbt) { #enablePlugin }
 
 This assumes you have a GitBook project under the `src/gitbook` directory. To change this, set the `sourceDirectory` key in the `GitBook` scope:
 
 ```sbt
-sourceDirectory in GitBook := sourceDirectory.value / "doc"
+GitBook / sourceDirectory := sourceDirectory.value / "doc"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `GitBook` scope:
 
-@@ snip[siteSubdirName](../../../sbt-test/gitbook/ignore-dot-files/build.sbt) { #siteSubdirName }
+@@ snip[siteSubdirName](/src/sbt-test/gitbook/ignore-dot-files/build.sbt) { #siteSubdirName }
 
 The plugin can also be configured to manage all GitBook setup and installation by configuring a dedicated directory in which GitBook's npm packages can be installed.
 
-@@ snip[gitbookInstallDir](../../../sbt-test/gitbook/can-manage-installation/build.sbt) { #gitbookInstallDir }
+@@ snip[gitbookInstallDir](/src/sbt-test/gitbook/can-manage-installation/build.sbt) { #gitbookInstallDir }
 
 [GitBook]: https://www.gitbook.com

src/main/paradox/generators/hugo.md

@@ -2,20 +2,20 @@
 
 The sbt-site plugin has support for building [Hugo] projects. To enable Hugo site generation, simply enable the associated plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/hugo/can-use-hugo/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/hugo/can-use-hugo/build.sbt) { #enablePlugin }
 
 The `hugo` binary must be installed on your `$PATH` in order to be accessible to sbt-site. In addition, this plugin assumes you have a Hugo project under the `src/hugo` directory. To change this, set the `sourceDirectory` key in the `Hugo` scope:
 
 ```sbt
-sourceDirectory in Hugo := sourceDirectory.value / "doc"
+Hugo / sourceDirectory := sourceDirectory.value / "doc"
 ```
 
 You may also change the [base-url](https://gohugo.io/overview/configuration/) that gets passed to the `hugo` command by adjusting the following setting:
 
-@@ snip[baseURL](../../../sbt-test/hugo/can-use-hugo/build.sbt) { #baseURL }
+@@ snip[baseURL](/src/sbt-test/hugo/can-use-hugo/build.sbt) { #baseURL }
 
 To export environment variables when forking the `hugo` process, for example to render with Hugo's [getenv function](https://hugodocs.info/functions/getenv/), use:
 
-@@ snip[extraEnv](../../../sbt-test/hugo/can-use-hugo/build.sbt) { #extraEnv }
+@@ snip[extraEnv](/src/sbt-test/hugo/can-use-hugo/build.sbt) { #extraEnv }
 
 [Hugo]: https://gohugo.io/

src/main/paradox/generators/jekyll.md

@@ -2,20 +2,20 @@
 
 The sbt-site plugin has direct support for running [Jekyll]. This is useful for supporting custom Jekyll plugins that are not allowed when publishing to GitHub, or hosting a Jekyll site on your own server. To add Jekyll support, enable the associated plugin:
 
-@@ snip[enablePlugin](../../../sbt-test/jekyll/can-use-jekyll/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/jekyll/can-use-jekyll/build.sbt) { #enablePlugin }
 
 This assumes you have a Jekyll project in the `src/jekyll` directory. To change this, set the key `sourceDirectory` in the `Jekyll` scope:
 
 ```sbt
-sourceDirectory in Jekyll := sourceDirectory.value / "hyde"
+Jekyll / sourceDirectory := sourceDirectory.value / "hyde"
 ```
 
 To redirect the output to a subdirectory of `target/site`, use the `siteSubdirName` key in `Jekyll` scope:
 
-@@ snip[siteSubdirName](../../../sbt-test/jekyll/can-use-jekyll/build.sbt) { #siteSubdirName }
+@@ snip[siteSubdirName](/src/sbt-test/jekyll/can-use-jekyll/build.sbt) { #siteSubdirName }
 
 One common issue with Jekyll is ensuring that everyone uses the same version for generating a website. There is special support for ensuring the version of gems. To do so, add the following to your `build.sbt` file:
 
-@@ snip[requiredGems](../../../sbt-test/jekyll/can-use-jekyll/build.sbt) { #requiredGems }
+@@ snip[requiredGems](/src/sbt-test/jekyll/can-use-jekyll/build.sbt) { #requiredGems }
 
 [Jekyll]: https://jekyllrb.com

src/main/paradox/generators/laika.md

@@ -3,12 +3,12 @@
 The sbt-site plugin has support for building [Laika] projects.
 To enable Laika site generation, simply enable the associated plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/laika_0.13/minimal/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/laika/minimal/build.sbt) { #enablePlugin }
 
 This plugin assumes you have a Laika project under the `src/laika` directory. To change this, set the `sourceDirectory` key in the `LaikaSite` scope:
 
 ```sbt
-sourceDirectory in LaikaSite := sourceDirectory.value / "doc"
+LaikaSite / sourceDirectory := sourceDirectory.value / "doc"
 ```
 
 This plugin use [Laika](https://github.com/planet42/Laika) sbt plugin internally and redefine default values for several Laika sbt keys which related to `sourceDirectory` in order to both work in harmony.
@@ -19,10 +19,7 @@ From other hand you can customize other aspects of Laika's behavior through basi
 [Laika sbt plugin](https://planet42.github.io/Laika/using-laika/sbt.html) keys and hooks.
 For example in order to add custom block directives you can include such code to your build.sbt:
 
-sbt 0.13
-:   @@ snip[laikaSbtPluginCustomization](../../../sbt-test/laika_0.13/blog-post/build.sbt) { #laikaSbtPluginCustomization }
-
-sbt 1.x
-:   @@ snip[laikaSbtPluginCustomization](../../../sbt-test/laika_1.x/blog-post/build.sbt) { #laikaSbtPluginCustomization }
+sbt
+:   @@ snip[laikaSbtPluginCustomization](/src/sbt-test/laika/blog-post/build.sbt) { #laikaSbtPluginCustomization }
 
 [Laika]: https://github.com/planet42/Laika

src/main/paradox/generators/nanoc.md

@@ -2,16 +2,16 @@
 
 The sbt-site plugin has direct support for building [Nanoc] projects. To enable Nanoc site generation, simply enable the associated plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/nanoc/can-use-nanoc/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/nanoc/can-use-nanoc/build.sbt) { #enablePlugin }
 
 This assumes you have a Nanoc project under the `src/nanoc` directory. To change this, set the `sourceDirectory` key in the `Nanoc` scope:
 
 ```sbt
-sourceDirectory in Nanoc := sourceDirectory.value / "conan"
+Nanoc / sourceDirectory := sourceDirectory.value / "conan"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Nanoc` scope:
 
-@@ snip[siteSubdirName](../../../sbt-test/nanoc/can-use-nanoc/build.sbt) { #siteSubdirName }
+@@ snip[siteSubdirName](/src/sbt-test/nanoc/can-use-nanoc/build.sbt) { #siteSubdirName }
 
 [Nanoc]: https://nanoc.ws/

src/main/paradox/generators/pamflet.md

@@ -2,16 +2,16 @@
 
 The sbt-site plugin has direct support for building [Pamflet] projects. To enable Pamflet site generation, simply enable the associated plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/pamflet/can-use-pamflet/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/pamflet/can-use-pamflet/build.sbt) { #enablePlugin }
 
 This assumes you have a Pamflet project under the `src/pamflet` directory. To change this, set the `sourceDirectory` key in the `Pamflet` scope:
 
 ```sbt
-sourceDirectory in Pamflet := sourceDirectory.value / "papyrus"
+Pamflet / sourceDirectory := sourceDirectory.value / "papyrus"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Pamflet` scope:
 
-@@ snip[siteSubdirName](../../../sbt-test/pamflet/can-use-pamflet/build.sbt) { #siteSubdirName }
+@@ snip[siteSubdirName](/src/sbt-test/pamflet/can-use-pamflet/build.sbt) { #siteSubdirName }
 
 [Pamflet]: http://www.foundweekends.org/pamflet/

src/main/paradox/generators/paradox.md

@@ -2,23 +2,25 @@
 
 The sbt-site plugin has direct support for building [Paradox] projects.
 
-To enable Paradox site generation, simply enable the associated plugin in your `build.sbt` file:
+To enable Paradox site generation, enable the `ParadoxSitePlugin` plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/paradox/can-use-paradox/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/paradox/can-use-paradox/build.sbt) { #enablePlugin }
 
-This assumes you have a Paradox project under the `src/paradox` directory. To change this, set the `sourceDirectory` key in the `Paradox` scope:
+This assumes you have a Paradox project under the `src/main/paradox` directory.
+To change this, set the `sourceDirectory` key in the `paradox` task scope:
 
 ```sbt
-sourceDirectory in Paradox := sourceDirectory.value / "doc"
+paradox / sourceDirectory := sourceDirectory.value / "doc"
 ```
 
 If you are configuring Paradox from scratch remember to also configure a theme:
 
-@@ snip[paradoxTheme](../../../sbt-test/paradox/can-use-paradox/build.sbt) { #paradoxTheme }
+@@ snip[paradoxTheme](/src/sbt-test/paradox/can-use-paradox/build.sbt) { #paradoxTheme }
 
-Note that Paradox settings such as `paradoxProperties` should be scoped to `Paradox` instead of `Compile` as used in the [Paradox documentation]. For example to configure an `@extref` link prefix use:
+Note that all of the Paradox settings mentioned in the [Paradox documentation] are reused by sbt-site.
+For example to configure an `@extref` link prefix use:
 
-@@ snip[paradoxProperties](../../../sbt-test/paradox/can-use-paradox/build.sbt) { #paradoxProperties }
+@@ snip[paradoxProperties](/src/sbt-test/paradox/can-use-paradox/build.sbt) { #paradoxProperties }
 
 [Paradox]: https://github.com/lightbend/paradox
 [Paradox documentation]: https://developer.lightbend.com/docs/paradox/latest/

src/main/paradox/generators/sphinx.md

@@ -2,16 +2,16 @@
 
 The sbt-site plugin has direct support for building [Sphinx] projects. To enable Sphinx site generation, simply enable the associated plugin in your `build.sbt` file:
 
-@@ snip[enablePlugin](../../../sbt-test/sphinx/can-use-sphinx/build.sbt) { #enablePlugin }
+@@ snip[enablePlugin](/src/sbt-test/sphinx/can-use-sphinx/build.sbt) { #enablePlugin }
 
 This assumes you have a Sphinx project under the `src/sphinx` directory. To change this, set the `sourceDirectory` key in the `Sphinx` scope:
 
 ```sbt
-sourceDirectory in Sphinx := sourceDirectory.value / "androsphinx"
+Sphinx / sourceDirectory := sourceDirectory.value / "androsphinx"
 ```
 
 Similarly, the output can be redirected to a subdirectory of `target/site` via the `siteSubdirName` key in `Sphinx` scope:
 
-@@ snip[siteSubdirName](../../../sbt-test/sphinx/can-use-sphinx/build.sbt) { #siteSubdirName }
+@@ snip[siteSubdirName](/src/sbt-test/sphinx/can-use-sphinx/build.sbt) { #siteSubdirName }
 
 [Sphinx]: http://sphinx-doc.org

src/main/paradox/getting-started.md

@@ -67,7 +67,7 @@ To create a zip package of the site run `package-site`.
 
 To also include this zip file as an artifact when running `publish`, add the following to your `build.sbt`:
 
-@@ snip[publishSite](../../sbt-test/site/can-package-and-publish-zip-file/build.sbt) { #publishSite }
+@@ snip[publishSite](/src/sbt-test/site/can-package-and-publish-zip-file/build.sbt) { #publishSite }
 
 Once you have generated and packaged your site the next step is to publish it. The @ref:[publishing](publishing.md) section discusses several mechanisms, such as [sbt-ghpages].
 

src/main/paradox/index.md

@@ -6,10 +6,9 @@ Before upgrading please consult the @github:[release notes](/notes/). Instructio
 
 @@@ note
 
+* Version 1.4+ is published for sbt 1.2.x.
 * Version 1.3+ is cross published to both sbt 0.13 and sbt 1.x.
 * As of sbt-site version 1.x.x, sbt version 0.13.10+ or 1.0.0-RC2+ is supported.
-* For earlier 0.13.x releases, use [version 0.8.2][0.8.2].
-* For sbt 0.12, use [version 0.7.2][0.7.2].
 
 @@@
 
@@ -28,6 +27,4 @@ Before upgrading please consult the @github:[release notes](/notes/). Instructio
 
 @@@
 
-[0.7.2]: https://github.com/sbt/sbt-site/tree/v0.7.2
-[0.8.2]: https://github.com/sbt/sbt-site/tree/v0.8.2
 [sbt-ghpages]: https://github.com/sbt/sbt-ghpages