/* * Licensed to the Apache Software Foundation (ASF) under one or more * license agreements; and to You under the Apache License, version 2.0: * * https://www.apache.org/licenses/LICENSE-2.0 * * This file is part of the Apache Pekko project, derived from Akka. */ /* * Copyright (C) 2019-2022 Lightbend Inc. */ package org.apache.pekko import com.lightbend.paradox.sbt.ParadoxPlugin import com.lightbend.paradox.sbt.ParadoxPlugin.autoImport._ import com.lightbend.paradox.apidoc.ApidocPlugin import com.lightbend.sbt.publishrsync.PublishRsyncPlugin.autoImport._ import sbt.Keys._ import sbt._ import scala.concurrent.duration._ object Paradox { val pekkoBaseURL = "https://pekko.apache.org" val propertiesSettings = Seq( Compile / paradoxProperties ++= Map( "canonical.base_url" -> s"$pekkoBaseURL/docs/pekko/current", "github.base_url" -> GitHub .url(version.value), // for links like this: @github[#1](#1) or @github[83986f9](83986f9) "extref.pekko.http.base_url" -> s"$pekkoBaseURL/docs/pekko-http/current/%s", "extref.pekko-management.base_url" -> s"$pekkoBaseURL/docs/pekko-management/current/%s", "extref.platform-guide.base_url" -> "https://developer.lightbend.com/docs/akka-platform-guide/%s", "extref.wikipedia.base_url" -> "https://en.wikipedia.org/wiki/%s", "extref.github.base_url" -> (GitHub.url(version.value) + "/%s"), // for links to our sources "extref.samples.base_url" -> "https://developer.lightbend.com/start/?group=akka&project=%s", "extref.ecs.base_url" -> "https://example.lightbend.com/v1/download/%s", "pekko.doc.dns" -> s"$pekkoBaseURL", "scaladoc.pekko.base_url" -> s"$pekkoBaseURL/api/pekko/current/org/apache", "scaladoc.pekko.http.base_url" -> s"$pekkoBaseURL/api/pekko-http/current/org/apache", "javadoc.java.base_url" -> "https://docs.oracle.com/en/java/javase/11/docs/api/java.base/", "javadoc.java.link_style" -> "direct", "javadoc.pekko.base_url" -> s"$pekkoBaseURL/japi/pekko/current/org/apache", "javadoc.pekko.link_style" -> "direct", "javadoc.akka.http.base_url" -> s"$pekkoBaseURL/japi/pekko-http/current/org/apache", "javadoc.akka.http.link_style" -> "frames", "javadoc.com.fasterxml.jackson.annotation.base_url" -> "https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/latest/", "javadoc.com.fasterxml.jackson.annotation.link_style" -> "direct", "javadoc.com.fasterxml.jackson.databind.base_url" -> "https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/latest/", "javadoc.com.fasterxml.jackson.databind.link_style" -> "direct", "javadoc.com.google.protobuf.base_url" -> "https://javadoc.io/doc/com.google.protobuf/protobuf-java/latest/", "javadoc.com.google.protobuf.link_style" -> "direct", "javadoc.com.typesafe.config.base_url" -> "https://javadoc.io/doc/com.typesafe/config/latest/", "javadoc.com.typesafe.config.link_style" -> "direct", "javadoc.org.slf4j.base_url" -> "https://www.javadoc.io/doc/org.slf4j/slf4j-api/latest/org.slf4j", "javadoc.org.slf4j.link_style" -> "direct", "scala.version" -> scalaVersion.value, "scala.binary.version" -> scalaBinaryVersion.value, "pekko.version" -> version.value, "scalatest.version" -> Dependencies.scalaTestVersion.value, "sigar_loader.version" -> "1.6.6-rev002", "algolia.docsearch.api_key" -> "543bad5ad786495d9ccd445ed34ed082", "algolia.docsearch.index_name" -> "akka_io", "google.analytics.account" -> "UA-21117439-1", "google.analytics.domain.name" -> "akka.io", "signature.akka.base_dir" -> (ThisBuild / baseDirectory).value.getAbsolutePath, "fiddle.code.base_dir" -> (Test / sourceDirectory).value.getAbsolutePath, "fiddle.akka.base_dir" -> (ThisBuild / baseDirectory).value.getAbsolutePath, "aeron_version" -> Dependencies.aeronVersion, "netty_version" -> Dependencies.nettyVersion, "logback_version" -> Dependencies.logbackVersion)) val rootsSettings = Seq( paradoxRoots := List( "index.html", // TODO page not linked to "fault-tolerance-sample.html")) // FIXME https://github.com/lightbend/paradox/issues/350 // Exclusions from direct compilation for includes dirs/files not belonging in a TOC val includesSettings = Seq( (Compile / paradoxMarkdownToHtml / excludeFilter) := (Compile / paradoxMarkdownToHtml / excludeFilter).value || ParadoxPlugin.InDirectoryFilter((Compile / paradox / sourceDirectory).value / "includes"), // Links are interpreted relative to the page the snippet is included in, // instead of relative to the place where the snippet is declared. (Compile / paradoxMarkdownToHtml / excludeFilter) := (Compile / paradoxMarkdownToHtml / excludeFilter).value || ParadoxPlugin.InDirectoryFilter((Compile / paradox / sourceDirectory).value / "includes.html")) val groupsSettings = Seq(Compile / paradoxGroups := Map("Language" -> Seq("Scala", "Java"))) val parsingSettings = Seq(Compile / paradoxParsingTimeout := 5.seconds) val settings = propertiesSettings ++ rootsSettings ++ includesSettings ++ groupsSettings ++ parsingSettings ++ Seq( Compile / paradox / name := "Pekko", resolvers += Resolver.jcenterRepo, ApidocPlugin.autoImport.apidocRootPackage := "org.apache.pekko", publishRsyncArtifacts += { val releaseVersion = if (isSnapshot.value) "snapshot" else version.value (Compile / paradox).value -> s"www/docs/pekko/$releaseVersion" }) }