16306: Merge branch 'master'

[arvados.git] / doc / Rakefile

diff --git a/doc/Rakefile b/doc/Rakefile
index e1e91c0b721b5bb91759f3794da01a8a71e7da48..f7050dc41f1c1b2e717bb9b1c808c20bebe4f198 100644 (file)
--- a/doc/Rakefile
+++ b/doc/Rakefile
@@ -3,9 +3,21 @@
 #
 # 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"
 
+module Zenweb
+  class Site
+    @binary_files = %w[png jpg gif eot svg ttf woff2? ico pdf m4a t?gz xlsx]
+  end
+end
+
 task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
   vars = ['baseurl', 'arvados_cluster_uuid', 'arvados_api_host', 'arvados_workbench_host']
   vars.each do |v|
@@ -15,22 +27,34 @@ task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/
   end
 end
 
+file ["install/new_cluster_checklist_Azure.xlsx", "install/new_cluster_checklist_AWS.xlsx"] do |t|
+  cp(t, t)
+end
+
 file "sdk/python/arvados/index.html" do |t|
-  `which epydoc`
+  if ENV['NO_SDK'] || File.exists?("no-sdk")
+    next
+  end
+  `which pdoc`
   if $? == 0
-    STDERR.puts `epydoc --html --parse-only -o sdk/python/arvados ../sdk/python/arvados/ 2>&1`
+    STDERR.puts `pdoc --html -o sdk/python ../sdk/python/arvados/ 2>&1`
     raise if $? != 0
   else
-    puts "Warning: epydoc not found, Python documentation will not be generated".colorize(:light_red)
+    puts "Warning: pdoc3 not found, Python documentation will not be generated".colorize(:light_red)
   end
 end
 
 file "sdk/R/arvados/index.html" do |t|
+  if ENV['NO_SDK'] || File.exists?("no-sdk")
+    next
+  end
   `which R`
   if $? == 0
     tgt = Dir.pwd
     Dir.mkdir("sdk/R")
     Dir.mkdir("sdk/R/arvados")
+    puts("tgt", tgt)
+    cp('css/R.css', 'sdk/R/arvados')
     docfiles = []
     Dir.chdir("../sdk/R/") do
       STDERR.puts `Rscript createDoc.R README.Rmd #{tgt}/sdk/R/README.md 2>&1`
@@ -88,15 +112,26 @@ EOF
 end
 
 file "sdk/java-v2/javadoc/index.html" do |t|
+  if ENV['NO_SDK'] || 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
+        puts `sed -i "s/@import.*dejavu.css.*//g" build/docs/javadoc/stylesheet.css`
+        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
@@ -122,6 +157,7 @@ end
 require "zenweb/tasks"
 load "zenweb-textile.rb"
 load "zenweb-liquid.rb"
+load "zenweb-fix-body.rb"
 
 task :extra_wirings do
   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")