From ccfece538e47303448c23ad3687ac735393681dd Mon Sep 17 00:00:00 2001 From: Travis Brown Date: Wed, 28 Jan 2015 15:54:00 -0600 Subject: [PATCH] Add publishing tools for API docs --- README.md | 7 ++++--- build.sbt | 9 ++++++++- project/plugins.sbt | 7 ++++++- 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7fd623d..f81cfdf 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ [![Build status](https://img.shields.io/travis/finagle/finagle-smtp/master.svg)](http://travis-ci.org/finagle/finagle-smtp) [![Coverage status](https://img.shields.io/coveralls/finagle/finagle-smtp/master.svg)](https://coveralls.io/r/finagle/finagle-smtp?branch=master) This is a minimum implementation of SMTP client for finagle according to -[`RFC5321`][rfc]. The simplest guide to SMTP can be found, for example, [here][smtp2go]. +[`RFC5321`][rfc]. Please see the [API documentation][docs] for information +that isn't covered in the introduction below. Note: There is no API yet in this implementation for creating [`MIME`][mimewiki] messages, so the message should be plain US-ASCII text, or converted @@ -11,7 +12,7 @@ to such. There is currently no support for any other SMTP extensions, either. Th functionality is to be added in future versions. [rfc]: http://tools.ietf.org/search/rfc5321 -[smtp2go]: http://www.smtp2go.com/articles/smtp-protocol +[docs]: https://finagle.github.io/finagle-smtp/docs/ [mimewiki]: http://en.wikipedia.org/wiki/MIME ## Usage @@ -101,4 +102,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License. diff --git a/build.sbt b/build.sbt index 1963ee5..c28b822 100644 --- a/build.sbt +++ b/build.sbt @@ -15,7 +15,14 @@ lazy val root = project.in(file(".")) "org.mockito" % "mockito-all" % "1.10.19" % "test", "org.scalatest" %% "scalatest" % "2.2.3" % "test" ) - ).settings(publishSettings: _*) + ) + .settings(publishSettings: _*) + .settings(site.settings: _*) + .settings(site.includeScaladoc("docs"): _*) + .settings(ghpages.settings: _*) + .settings( + git.remoteRepo := "git@github.com:finagle/finagle-smtp.git" + ) lazy val publishSettings = Seq( publishMavenStyle := true, diff --git a/project/plugins.sbt b/project/plugins.sbt index 7b43f5d..c9bfee6 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -1,5 +1,10 @@ -resolvers += Classpaths.sbtPluginReleases +resolvers ++= Seq( + "jgit-repo" at "http://download.eclipse.org/jgit/maven", + Classpaths.sbtPluginReleases +) addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.0.0") +addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.5.3") +addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.8.1") addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.0.4") addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.0.0.BETA1") \ No newline at end of file