Montag, 3. März 2014

API documentation for SBT project

Laika can help you easily add documentation to your SBT project. Whole process is described here and following list contains necessary steps:
  1. Add a line to your project/plugins.sbt file
    addSbtPlugin("org.planet42" % "laika-sbt" % "0.5.0")
  2. These lines to build.sbt
    import laika.sbt.LaikaSbtPlugin.{LaikaPlugin, LaikaKeys}
    import LaikaKeys._
  3. If you want to redefine default settings
    sourceDirectories in Laika := Seq(new"app/docs"))
    includeAPI in Laika := true
  4. Build documentation by executing following command from SBT console

Keine Kommentare:

Kommentar veröffentlichen