Documentation

kantan.sbt adds a new DocumentationPlugin. Enabling it on a project will:

• mark it as Unpublished
• enable sbt-unidoc
• enable sbt-site’s PreprocessPlugin
• enable tut
• enable sbt-ghpages

All these plugins put together mean that, when you run makeSite:

• all files in src/site will be copied to target/site
• all files in src/main/tut will be preprocessed and tut-compiled, and the output copied to target/site

Running ghpagesPushSite will then push this to your project ghpages branch.

This requires the git.remoteRepo setting to be set to your project’s URI on github.

Additionally, if scmInfo is set, your scaladoc will link to your project’s source on github.

---

Other tutorials:

• Out of the box behaviours
• Style validation
• Strict compilation
• Publication
• Documentation
• Release
• Scala.js