Skip to content

[SPARK-12000] Fix API doc generation issues #10049

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.

Sign up for GitHub

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

Closed
JoshRosen wants to merge 4 commits into from
Closed

[SPARK-12000] Fix API doc generation issues #10049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
85ba648
Ensure that Jekyll build fails if API doc generation fails.
JoshRosen Nov 30, 2015
7d7c99c
Fix Javadoc by handling -target flag differently.
JoshRosen Nov 30, 2015
38c1390
Include Tim's Javadoc changes.
thunterdb Nov 26, 2015
6714e3e
Exclude testTags subproject from Scaladoc + Javadoc.
JoshRosen Nov 30, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/_plugins/copy_api_dirs.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
cd("..")

puts "Running 'build/sbt -Pkinesis-asl clean compile unidoc' from " + pwd + "; this may take a few minutes..."
puts `build/sbt -Pkinesis-asl clean compile unidoc`
system("build/sbt -Pkinesis-asl clean compile unidoc") || raise("Unidoc generation failed")

puts "Moving back into docs dir."
cd("docs")
Expand Down Expand Up @@ -117,7 +117,7 @@

puts "Moving to python/docs directory and building sphinx."
cd("../python/docs")
puts `make html`
system(make html) || raise("Python doc generation failed")
Copy link
Contributor Author

@JoshRosen JoshRosen Dec 1, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, forgot the quotes here. Will fix in a followup PR or a hotfix.


puts "Moving back into home dir."
cd("../../")
Expand All @@ -131,7 +131,7 @@
# Build SparkR API docs
puts "Moving to R directory and building roxygen docs."
cd("R")
puts `./create-docs.sh`
system("./create-docs.sh") || raise("R doc generation failed")

puts "Moving back into home dir."
cd("../")
Expand Down
4 changes: 2 additions & 2 deletions network/common/src/main/java/org/apache/spark/network/client/StreamCallback.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
import java.nio.ByteBuffer;

/**
* Callback for streaming data. Stream data will be offered to the {@link onData(ByteBuffer)}
* method as it arrives. Once all the stream data is received, {@link onComplete()} will be
* Callback for streaming data. Stream data will be offered to the {@link onData(String, ByteBuffer)}
* method as it arrives. Once all the stream data is received, {@link onComplete(String)} will be
* called.
* <p>
* The network library guarantees that a single thread will call these methods at a time, but
Expand Down
2 changes: 1 addition & 1 deletion network/common/src/main/java/org/apache/spark/network/server/RpcHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public abstract void receive(

/**
* Receives an RPC message that does not expect a reply. The default implementation will
* call "{@link receive(TransportClient, byte[], RpcResponseCallback}" and log a warning if
* call "{@link receive(TransportClient, byte[], RpcResponseCallback)}" and log a warning if
* any of the callback methods are called.
*
* @param client A channel client which enables the handler to make requests back to the sender
Expand Down
11 changes: 8 additions & 3 deletions project/SparkBuild.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,12 @@ object SparkBuild extends PomBuild {

javacOptions in Compile ++= Seq(
"-encoding", "UTF-8",
"-source", javacJVMVersion.value,
"-source", javacJVMVersion.value
),
// This -target option cannot be set in the Compile configuration scope since `javadoc` doesn't
// play nicely with it; see https://github.com/sbt/sbt/issues/355#issuecomment-3817629 for
// additional discussion and explanation.
javacOptions in (Compile, compile) ++= Seq(
"-target", javacJVMVersion.value
),

Expand Down Expand Up @@ -547,9 +552,9 @@ object Unidoc {
publish := {},

unidocProjectFilter in(ScalaUnidoc, unidoc) :=
inAnyProject -- inProjects(OldDeps.project, repl, examples, tools, streamingFlumeSink, yarn),
inAnyProject -- inProjects(OldDeps.project, repl, examples, tools, streamingFlumeSink, yarn, testTags),
unidocProjectFilter in(JavaUnidoc, unidoc) :=
inAnyProject -- inProjects(OldDeps.project, repl, bagel, examples, tools, streamingFlumeSink, yarn),
inAnyProject -- inProjects(OldDeps.project, repl, bagel, examples, tools, streamingFlumeSink, yarn, testTags),

// Skip actual catalyst, but include the subproject.
// Catalyst is not public API and contains quasiquotes which break scaladoc.
Expand Down