网站版本控制

此文档页面特定于 Scala 3，可能涵盖 Scala 2 中不可用的新概念。 除非另有说明，否则此页面中的所有代码示例均假设您使用的是 Scala 3。

Scaladoc 提供了一种方便的方法来在不同版本的文档之间切换。 如果我们想为尚未迁移到新版本的库的用户公开旧文档，此功能非常有用。

如何设置它

此功能旨在易于扩展，无需在添加新版本后重新生成所有 scaladoc。 为此，引入了新的设置：-versions-dictionary-url。 它的参数必须是指向 JSON 文档的 URL，该文档包含有关特定版本位置的信息。 JSON 文件具有单个属性 versions，它保存将特定版本文档的标签与指向其 index.html 的 URL 关联的字典。

示例 JSON 文件

{
  "versions": {
    "3.0.x": "https://dotty.epfl.ch/3.0.x/docs/index.html",
    "Nightly": "https://dotty.epfl.ch/docs/index.html"
  }
}

这迫使我们在为每个版本生成文档时提供设置，但这让我们在以后拥有更大的灵活性。如果你想在已发布的 5 个版本旁边添加一个 API 文档版本，那么你只需要将新文档上传到 Web 服务器并在 JSON 文件中添加一个新条目。现在，网站的所有版本都将意识到新的网站版本。

需要注意的是，只有一个 JSON 文件以避免冗余，并且每个 scaladoc 必须事先设置其 URL 位置，例如在 sbt 中

doc / scalacOptions ++= Seq("-versions-dictionary-url", "https://dotty.epfl.ch/versions.json")

从用户角度来看它是什么样的

通过 -versions-dictionary-url 提供 JSON 文件使 scaladoc 能够在版本之间链接。能够更改下拉菜单中的修订标签也很方便。一切都会自动更改。