Create TypelevelUnidocPlugin
#119
Conversation
build.sbt
Outdated
| lazy val unidoc = project | ||
| .in(file("unidoc")) | ||
| .enablePlugins(TypelevelUnidocPlugin) | ||
| .settings( | ||
| name := "sbt-typelevel-unidoc" | ||
| ) |
There was a problem hiding this comment.
This is how you set it up. Choice of "unidoc" for the module name is arbitrary—it would be good to establish a best practice.
There was a problem hiding this comment.
Actually: this might not even need a separate module. In theory you could enable the TypelevelUnidocPlugin on your core module and it would replace its API docs artifact with the unidoc artifact. Not entirely sure if this would work—could be playing with fire.
Edit: just tried this and it seems to work 😅
| ) | ||
|
|
||
| private[sbt] def javadocioUrl = Def.setting { | ||
| if (isSnapshot.value) None // javadoc.io doesn't support snapshots |
There was a problem hiding this comment.
build.sbt
Outdated
| tlSiteApiModule := Some((unidoc / projectID).value), | ||
| tlSiteApiPackage := Some("org.typelevel.sbt") |
There was a problem hiding this comment.
I have an idea to set tlSiteApiModule := Some((unidoc / projectID).value) automatically.
There was a problem hiding this comment.
A bit reflection-y but gets the job done :)
build.sbt
Outdated
| // Doesn't conflict w/ core artifact since this one won't have the sbt cross version suffix | ||
| // javadoc.io doesn't recognize sbt artifacts, so we must publish like this | ||
| name := "sbt-typelevel", |
There was a problem hiding this comment.
In retrospect not sure if naming the artifact sbt-typelevel is a good idea. sbt-typelevel-docs or sbt-typelevel-unidoc etc. is much better.
|
I got additional support for this idea in erikerlandson/coulomb#233 (reply in thread). So I'm going to move ahead with it for the next release :) |
This one is pretty simple. A plugin to publish a unidoc artifact to sonatype/maven accessible via javadoc.io, e.g.:
https://www.javadoc.io/doc/org.typelevel/sbt-typelevel_2.12/0.4.4/AFAIK since javadoc.io can't render snapshots, you can't really update docs between releases.