Skip to content

Commit 8856077

Browse files
add Documentation section to README
1 parent 28fe2e2 commit 8856077

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

language-adaptors/rxjava-scala/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,17 @@ Scala code using Rx should only import members from `rx.lang.scala` and below.
6565
Work on this adaptor is still in progress, and for the moment, the best source of documentation are the comments in the source code of [`rx.lang.scala.Observable`](https://github.com/Netflix/RxJava/blob/master/language-adaptors/rxjava-scala/src/main/scala/rx/lang/scala/Observable.scala).
6666

6767

68+
## Documentation
69+
70+
You can build the documentation as follows: In the RxJava root directory, run
71+
72+
./gradlew :language-adaptors:rxjava-scala:scaladoc
73+
74+
Then navigate to
75+
76+
RxJava/language-adaptors/rxjava-scala/build/docs/scaladoc/index.html
77+
78+
6879
## Binaries
6980

7081
Binaries and dependency information for Maven, Ivy, Gradle and others can be found at [http://search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22rxjava-scala%22).

0 commit comments

Comments
 (0)