Skip to content

Commit 3aa3eed

Browse files
committed
Issue monix#58 - fix Build.scala (scaladoc, etc.)
1 parent 197ed0f commit 3aa3eed

File tree

4 files changed

+45
-14
lines changed

4 files changed

+45
-14
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Idiomatic Reactive Extensions for Scala. Targets both the JVM and [Scala.js](http://www.scala-js.org/).
44

5-
[![Build Status](https://travis-ci.org/monifu/monifu.png?branch=v1.0-M6)](https://travis-ci.org/monifu/monifu)
5+
[![Build Status](https://travis-ci.org/monifu/monifu.png?branch=v1.0-M7)](https://travis-ci.org/monifu/monifu)
66
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/monifu/monifu?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77

88
## Teaser
@@ -60,18 +60,18 @@ Release Notes:
6060
The packages are published on Maven Central. Compiled for Scala 2.11.5
6161
and Scala.js 0.6.0. Older versions are no longer supported.
6262

63-
- Current stable release is: `1.0-M6`
63+
- Current stable release is: `1.0-M7`
6464

6565
### For the JVM
6666

6767
```scala
68-
libraryDependencies += "org.monifu" %% "monifu" % "1.0-M6"
68+
libraryDependencies += "org.monifu" %% "monifu" % "1.0-M7"
6969
```
7070

7171
### For targeting Javascript runtimes with Scala.js
7272

7373
```scala
74-
libraryDependencies += "org.monifu" %%% "monifu" % "1.0-M6"
74+
libraryDependencies += "org.monifu" %%% "monifu" % "1.0-M7"
7575
```
7676

7777
## License
File renamed without changes.

jvm/rootdoc.txt

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<img src="https://raw.githubusercontent.com/wiki/alexandru/monifu/assets/monifu.png" align="right" />
2+
3+
This is the API documentation for the [[https://github.com/alexandru/monifu Monifu]] library.
4+
5+
==Overview==
6+
7+
Monifu is a library for functional reactive programming. Checkout the [[http://www.reactivemanifesto.org/ Reactive Manifesto]] for the need to go reactive.
8+
9+
Monifu brings an implementation of [[https://rx.codeplex.com/ Reactive Extensions]],
10+
with back-pressure added (also the [[http://www.reactive-streams.org/ Reactive Streams effort]]),
11+
plus multi-threading primitives for building efficient, concurrent and non-blocking algorithms.
12+
13+
==Rx Sample==
14+
15+
Sample: {{{
16+
import monifu.concurrent.Implicits.globalScheduler
17+
import play.api.libs.ws._
18+
import monifu.reactive._
19+
20+
// emits an auto-incremented number, every second
21+
Observable.interval(1.second)
22+
// drops the first 10 emitted events
23+
.drop(10)
24+
// takes the first 100 emitted events
25+
.take(100)
26+
// per second, makes requests and concatenates the results
27+
.flatMap(x => WS.request(s"http://some.endpoint.com/request?tick=$x").get())
28+
// filters only valid responses
29+
.filter(response => response.status == 200)
30+
// processes response, selecting the body
31+
.map(response => response.body)
32+
// creates subscription, foreach response print it
33+
.foreach(x => println(x))
34+
}}}

project/Build.scala

+7-10
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ object Build extends SbtBuild {
2525
val compilerSettings = Seq(
2626
scalaVersion := "2.11.7",
2727

28-
scalacOptions <<= baseDirectory.map { bd => Seq("-sourcepath", bd.getAbsolutePath) },
2928
scalacOptions ++= Seq(
3029
"-unchecked", "-deprecation", "-feature", "-Xlint", "-target:jvm-1.6", "-Yinline-warnings",
3130
"-optimise", "-Ywarn-adapted-args", "-Ywarn-dead-code", "-Ywarn-inaccessible",
@@ -37,16 +36,12 @@ object Build extends SbtBuild {
3736
scalacOptions in (Compile, doc) ++=
3837
Opts.doc.sourceUrl(s"https://github.com/monifu/monifu/tree/v${version.value}/monifu€{FILE_PATH}.scala"),
3938
scalacOptions in (Compile, doc) ++=
40-
Opts.doc.title(s"Monifu"),
39+
Seq("-doc-root-content", baseDirectory.value + "/rootdoc.txt"),
4140
scalacOptions in (Compile, doc) ++=
4241
Opts.doc.version(s"${version.value}"),
43-
scalacOptions in (Compile, doc) ++=
44-
Seq("-doc-root-content", "rootdoc.txt"),
45-
scalacOptions in (Compile, doc) <<= baseDirectory.map(bd =>
46-
Seq(
47-
"-Ymacro-no-expand",
48-
"-sourcepath", bd.getAbsolutePath
49-
))
42+
scalacOptions in ThisBuild <++= baseDirectory.map { bd =>
43+
Seq("-sourcepath", bd.getAbsolutePath)
44+
}
5045
)
5146

5247
val sharedSettings = compilerSettings ++ Seq(
@@ -107,13 +102,15 @@ object Build extends SbtBuild {
107102
.settings(sharedSettings: _*)
108103
.settings(name := "monifu")
109104
.jvmSettings(
105+
scalacOptions in (Compile, doc) ++= Opts.doc.title(s"Monifu"),
110106
testFrameworks += new TestFramework("minitest.runner.Framework"),
111107
libraryDependencies ++= Seq(
112108
"org.reactivestreams" % "reactive-streams" % "1.0.0.final",
113109
"org.monifu" %% "minitest" % "0.13" % "test"
114110
))
115111
.jsSettings(
116-
// scalaJSStage in Test := FastOptStage,
112+
scalacOptions in (Compile, doc) ++= Opts.doc.title(s"Monifu (JS)"),
113+
scalaJSStage in Test := FastOptStage,
117114
testFrameworks += new TestFramework("minitest.runner.Framework"),
118115
libraryDependencies ++= Seq(
119116
"org.monifu" %%% "minitest" % "0.13" % "test"

0 commit comments

Comments
 (0)