2m / sbt-paradox-local Edit

Build paradox documentation with locally linked API docs

GitHub
Version Matrix

sbt-paradox-local

This plugin adds a Local sbt configuration to the sbt-paradox enabled projects which then can be used to generate paradox documentation with local API links.

Usage

Add this to your sbt build plugins in project/plugins.sbt:

addSbtPlugin("lt.dvim.paradox" % "sbt-paradox-local" % "0.2")

Set values for the following sbt keys:

// paradox properties key for the local project api base url
paradoxLocalApiKey := "scaladoc.<my.project>.base_url"

// directory where the local API scaladoc can be found
paradoxLocalApiDir := (myProject / Compile / doc).value

This plugin is then enabled automatically and you can use Local/paradox task to generate documentation with links to the locally generated API docs.

Documentation

Markdown Badge

Create badge

×
Markdown:
[![sbt-paradox-local Scala version support](https://index.scala-lang.org/2m/sbt-paradox-local/sbt-paradox-local/latest-by-scala-version.svg?targetType=Sbt)](https://index.scala-lang.org/2m/sbt-paradox-local/sbt-paradox-local)
addSbtPlugin("lt.dvim.paradox" % "sbt-paradox-local" % "0.1")
Ammonite REPL 
import $ivy.`lt.dvim.paradox::sbt-paradox-local:0.1`
<dependency>
  <groupId>lt.dvim.paradox</groupId>
  <artifactId>sbt-paradox-local</artifactId>
  <version>0.1</version>
</dependency>
compile group: 'lt.dvim.paradox', name: 'sbt-paradox-local', version: '0.1'
Mill build tool 
ivy"lt.dvim.paradox::sbt-paradox-local:0.1"
Try online with Scastie
Try on Scastie

Statistics

Contributors

License

6 dependencies