Merge branch '15946-collectionfs-deadlock'

[arvados.git] / doc / Rakefile

diff --git a/doc/Rakefile b/doc/Rakefile
index e1e91c0b721b5bb91759f3794da01a8a71e7da48..63dc16d25d6d84747a649d0685151dec7bdbfcbf 100644 (file)
--- a/doc/Rakefile
+++ b/doc/Rakefile
@@ -3,6 +3,12 @@
 #
 # SPDX-License-Identifier: CC-BY-SA-3.0
 
+# As a convenience to the documentation writer, you can touch a file
+# called 'no-sdk' in the 'doc' directory and it will suppress
+# generating the documentation for the SDKs, which (the R docs
+# especially) take a fair bit of time and slow down the edit-preview
+# cycle.
+
 require "rubygems"
 require "colorize"
 
@@ -16,6 +22,9 @@ task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/
 end
 
 file "sdk/python/arvados/index.html" do |t|
+  if File.exists? "no-sdk"
+    next
+  end
   `which epydoc`
   if $? == 0
     STDERR.puts `epydoc --html --parse-only -o sdk/python/arvados ../sdk/python/arvados/ 2>&1`
@@ -26,6 +35,9 @@ file "sdk/python/arvados/index.html" do |t|
 end
 
 file "sdk/R/arvados/index.html" do |t|
+  if File.exists? "no-sdk"
+    next
+  end
   `which R`
   if $? == 0
     tgt = Dir.pwd
@@ -88,15 +100,24 @@ EOF
 end
 
 file "sdk/java-v2/javadoc/index.html" do |t|
+  if File.exists? "no-sdk"
+    next
+  end
   `which java`
   if $? == 0
-    tgt = Dir.pwd
-    docfiles = []
-    Dir.chdir("../sdk/java-v2") do
-      STDERR.puts `./gradlew javadoc 2>&1`
+    `which gradle`
+    if $? != 0
+      puts "Warning: gradle not found, java sdk documentation will not be generated".colorize(:light_red)
+    else
+      tgt = Dir.pwd
+      docfiles = []
+      Dir.chdir("../sdk/java-v2") do
+        STDERR.puts `gradle javadoc 2>&1`
+        raise if $? != 0
+      end
+      cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
+      raise if $? != 0
     end
-    cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
-    raise if $? != 0
   else
     puts "Warning: java not found, java sdk documentation will not be generated".colorize(:light_red)
   end