👍 as well, and further, the current documentation lies:

> help ghpagesPushSite
Pushes a generated site into the ghpages branch.  Will not clean the branch unless you run clean-site first.

Note the second sentence, which appears to expressly suggest that existing content will be left alone, but reading the plugin code pushSite invokes syncLocal, which subsequently always invokes cleanSiteForRealz and 💥 there goes all the previously existing content.

As a guideline to help get people started, below is how I have set things up in hopes of generating (and retaining) versioned copies of Scaladoc. I'd be happy to work this into a contribution of plugin documentation, but as of now it falls short since ghpagesPushSite is always clobbering all the content of gh-pages—as @eed3si9n suggests the plugin seems to need some modification to support this conveniently.

// project/plugins.sbt
resolvers += "jgit-repo" at "http://download.eclipse.org/jgit/maven"

addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.0.0-RC3")
addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.5.4")

// build.sbt
autoAPIMappings := true
scalacOptions in (Compile, doc) ++= Seq(
  "-doc-title", "My Project",
  "-doc-version", version.value,
  "-groups"
)

enablePlugins(SiteScaladocPlugin)
siteSubdirName in SiteScaladoc := s"api/${version.value}"

// Builds static files in src/site-preprocess with variable substitution.
enablePlugins(PreprocessPlugin)
preprocessVars := Map("VERSION" -> version.value)

// Enables easy publishing to project's gh-pages.
ghpages.settings
git.remoteRepo := "git@github.com:ches/my-project.git"

<!-- src/site-preprocess/index.html -->

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Project Documentation</title>
    <script>
      <!--
      function doRedirect() {
        window.location.replace("api/@VERSION@/org/mygroup/myproject/package.html");
      }

      doRedirect();
      //-->
    </script>
  </head>

  <body>
    <a href="api/@VERSION@/org/mygroup/myproject/package.html">Go to the project documentation</a>
  </body>
</html>

Uh oh!

Document how to keep older api docs around #10

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions