Merge pull request #8 from lloydmeta/feature/scaladocs-publishing

Neat.

Author: lloydmeta

README.md

@@ -13,6 +13,8 @@ can take your enum values as arguments without having to worry about erasure (fo
 
 Compatible with Scala 2.10.x and 2.11.x
 
+[Scaladocs](https://beachape.com/enumeratum/latest/api)
+
 ## SBT
 
 For basic enumeratum (with no Play support):

project/Enumeratum.scala project/Build.scalaproject/Enumeratum.scala renamed to project/Build.scala

@@ -3,6 +3,11 @@ import sbt.Keys._
 import com.typesafe.sbt.SbtScalariform._
 import scalariform.formatter.preferences._
 import scoverage.ScoverageSbtPlugin.ScoverageKeys._
+import com.typesafe.sbt.SbtGhPages.ghpages
+import com.typesafe.sbt.SbtSite.site
+import sbtunidoc.Plugin.UnidocKeys._
+import sbtunidoc.Plugin._
+import com.typesafe.sbt.SbtGit.{GitKeys => git}
 
 object Enumeratum extends Build {
 
@@ -13,10 +18,24 @@ object Enumeratum extends Build {
   lazy val root = Project(id = "enumeratum-root", base = file("."), settings = commonWithPublishSettings)
     .settings(
       name := "enumeratum-root",
-      publishArtifact := false,
       crossScalaVersions := scalaVersions,
       crossVersion := CrossVersion.binary
-    ).aggregate(macros, core, enumeratumPlay, enumeratumPlayJson)
+    )
+    .settings(unidocSettings: _*)
+    .settings(site.settings ++ ghpages.settings: _*)
+    .settings(
+      site.addMappingsToSiteDir(
+        mappings in (ScalaUnidoc, packageDoc), "latest/api"
+      ),
+      git.gitRemoteRepo := "git@github.com:lloydmeta/enumeratum.git"
+    )
+    .settings(
+      scalacOptions in (ScalaUnidoc, unidoc) += "-Ymacro-no-expand",
+      // Do not publish the root project (it just serves as an aggregate)
+      publishArtifact := false,
+      publishLocal := {}
+    )
+    .aggregate(macros, core, enumeratumPlay, enumeratumPlayJson)
 
   lazy val core = Project(id = "enumeratum", base = file("enumeratum-core"), settings = commonWithPublishSettings)
     .settings(

project/plugins.sbt

@@ -1,11 +1,22 @@
 // The Typesafe repository
 resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"
 
+resolvers += "jgit-repo" at "http://download.eclipse.org/jgit/maven"
+
 resolvers += Classpaths.sbtPluginReleases
 
 // for code formatting
 addSbtPlugin("com.typesafe.sbt" % "sbt-scalariform" % "1.3.0")
 
 addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.0.1")
 
-addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.0.0.BETA1")
+addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.0.0.BETA1")
+
+// Provides the ability to generate unifed documentation for multiple projects
+addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.3.1")
+
+// Provides site generation functionality
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.8.1")
+
+// Provides auto-generating and publishing a gh-pages site
+addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.5.3")