Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update paradox theme to 0.23 #27505

Merged
merged 3 commits into from Aug 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion akka-docs/src/main/paradox/actors.md
Expand Up @@ -633,7 +633,7 @@ Scala
Java
: @@snip [ActorDocTest.java](/akka-docs/src/test/java/jdocs/actor/ActorDocTest.java) { #selection-remote }

An example demonstrating actor look-up is given in @ref:[Remoting Sample](remoting.md#remote-sample).
An example demonstrating actor look-up is given in @ref:[Remoting Sample](remoting.md#looking-up-remote-actors).

## Messages and immutability

Expand Down
2 changes: 1 addition & 1 deletion akka-docs/src/main/paradox/cluster-sharding.md
Expand Up @@ -421,7 +421,7 @@ Java

Note that stopped entities will be started again when a new message is targeted to the entity.

If 'on stop' backoff supervision strategy is used, a final termination message must be set and used for passivation, see @ref:[Supervision](general/supervision.md#Sharding)
If 'on stop' backoff supervision strategy is used, a final termination message must be set and used for passivation, see @ref:[Supervision](general/supervision.md#sharding)

## Graceful Shutdown

Expand Down
1 change: 1 addition & 0 deletions akka-docs/src/main/paradox/dispatchers.md
Expand Up @@ -35,6 +35,7 @@ Scala

Java
: @@snip [DispatcherDocTest.java](/akka-docs/src/test/java/jdocs/dispatcher/DispatcherDocTest.java) { #lookup }

## Setting the dispatcher for an Actor

So in case you want to give your `Actor` a different dispatcher than the default, you need to do two things, of which the first
Expand Down
1 change: 1 addition & 0 deletions akka-docs/src/main/paradox/logging.md
Expand Up @@ -204,6 +204,7 @@ akka {
}
```

<a id="logging-remote"></a>
### Auxiliary remote logging options

If you want to see all messages that are sent through remoting at DEBUG log level, use the following config option. Note that this logs the messages as they are sent by the transport layer, not by an actor.
Expand Down
Expand Up @@ -2,8 +2,6 @@

Fan-out the stream to several streams.

@ref[Fan-out operators](../index.md#fan-out-operators)

## Description

Fan-out the stream to several streams. Each upstream element is emitted to the first available downstream consumer.
Expand Down
Expand Up @@ -2,8 +2,6 @@

Emit each incoming element each of `n` outputs.

@ref[Fan-out operators](../index.md#fan-out-operators)

## Description

Emit each incoming element each of `n` outputs.
Expand Down
Expand Up @@ -2,8 +2,6 @@

Fan-out the stream to several streams.

@ref[Fan-out operators](../index.md#fan-out-operators)

## Signature

## Description
Expand Down
Expand Up @@ -2,8 +2,6 @@

Takes a stream of two element tuples and unzips the two elements ino two different downstreams.

@ref[Fan-out operators](../index.md#fan-out-operators)

## Signature

## Description
Expand Down
Expand Up @@ -2,8 +2,6 @@

Splits each element of input into multiple downstreams using a function

@ref[Fan-out operators](../index.md#fan-out-operators)

## Signature

## Description
Expand Down
4 changes: 2 additions & 2 deletions akka-docs/src/main/paradox/stream/stream-introduction.md
Expand Up @@ -63,7 +63,7 @@ composition, therefore it may take some careful study of this subject until you
feel familiar with the tools and techniques. The documentation is here to help
and for best results we recommend the following approach:

* Read the @ref:[Quick Start Guide](stream-quickstart.md#stream-quickstart) to get a feel for how streams
* Read the @ref:[Quick Start Guide](stream-quickstart.md) to get a feel for how streams
look like and what they can do.
* The top-down learners may want to peruse the @ref:[Design Principles behind Akka Streams](../general/stream/stream-design.md) at this
point.
Expand All @@ -72,4 +72,4 @@ point.
* For a complete overview of the built-in processing operators you can look at the
@ref:[operator index](operators/index.md)
* The other sections can be read sequentially or as needed during the previous
steps, each digging deeper into specific topics.
steps, each digging deeper into specific topics.
1 change: 1 addition & 0 deletions akka-docs/src/main/paradox/testing.md
Expand Up @@ -20,6 +20,7 @@ perform tests.

Akka comes with a dedicated module `akka-testkit` for supporting tests.

<a id="async-integration-testing"></a>
## Asynchronous Testing: `TestKit`

Testkit allows you to test your actors in a controlled but realistic
Expand Down
4 changes: 2 additions & 2 deletions akka-docs/src/main/paradox/typed/routers.md
Expand Up @@ -38,7 +38,7 @@ Java

## Group Router

The group router is created with a `ServiceKey` and uses the receptionist (see @ref:[Receptionist](actor-discovery.md#Receptionist)) to discover
The group router is created with a `ServiceKey` and uses the receptionist (see @ref:[Receptionist](actor-discovery.md#receptionist)) to discover
available actors for that key and routes messages to one of the currently known registered actors for a key.

Since the receptionist is used this means the group router is cluster aware out of the box and will pick up routees
Expand Down Expand Up @@ -86,4 +86,4 @@ it will not give better performance to create more routees than there are thread

Since the router itself is an actor and has a mailbox this means that messages are routed sequentially to the routees
where it can be processed in parallel (depending on the available threads in the dispatcher).
In a high throughput use cases the sequential routing could be a bottle neck. Akka Typed does not provide an optimized tool for this.
In a high throughput use cases the sequential routing could be a bottle neck. Akka Typed does not provide an optimized tool for this.
17 changes: 17 additions & 0 deletions build.sbt
Expand Up @@ -269,6 +269,23 @@ lazy val docs = akkaModule("akka-docs")
"fiddle.akka.base_dir" -> (baseDirectory in ThisBuild).value.getAbsolutePath,
),
Compile / paradoxGroups := Map("Language" -> Seq("Scala", "Java")),
paradoxRoots := List(
// Intentional roots:
"index.html",
"typed-actors.html",
// (to be) fixed on master:
"common/io-layer.html",
"fault-tolerance-sample.html",
"stream/operators/Source-or-Flow/apply.html",
"stream/operators/Source-or-Flow/balance.html",
"stream/operators/Source-or-Flow/broadcast.html",
"stream/operators/Source-or-Flow/mergeLatest.html",
"stream/operators/Source-or-Flow/mergePreferred.html",
"stream/operators/Source-or-Flow/mergePrioritized.html",
"stream/operators/Source-or-Flow/partition.html",
"stream/operators/Source-or-Flow/unzip.html",
"stream/operators/Source-or-Flow/unzipWith.html",
),
resolvers += Resolver.jcenterRepo,
apidocRootPackage := "akka",
deployRsyncArtifact := List((paradox in Compile).value -> s"www/docs/akka/${version.value}")
Expand Down
2 changes: 1 addition & 1 deletion project/plugins.sbt
Expand Up @@ -15,7 +15,7 @@ addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.3.4")
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.15")
addSbtPlugin("io.spray" % "sbt-boilerplate" % "0.6.1")
addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.3.4")
addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.18")
addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.23")
addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-apidoc" % "0.1+9-d846d815")
addSbtPlugin("com.lightbend" % "sbt-whitesource" % "0.1.13")
addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "1.0.0")
Expand Down