X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/89f10cd956b1282d8d650fd82f945f8169664df9..e5fd3db8efdd8e6b8f65d81663ae65964b64c206:/doc/Rakefile diff --git a/doc/Rakefile b/doc/Rakefile index c3888c5f69..f7050dc41f 100644 --- 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,21 +27,25 @@ 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| - if File.exists? "no-sdk" + if ENV['NO_SDK'] || File.exists?("no-sdk") next end - `which epydoc` + `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 File.exists? "no-sdk" + if ENV['NO_SDK'] || File.exists?("no-sdk") next end `which R` @@ -37,6 +53,8 @@ file "sdk/R/arvados/index.html" do |t| 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` @@ -94,7 +112,7 @@ EOF end file "sdk/java-v2/javadoc/index.html" do |t| - if File.exists? "no-sdk" + if ENV['NO_SDK'] || File.exists?("no-sdk") next end `which java` @@ -108,6 +126,8 @@ file "sdk/java-v2/javadoc/index.html" do |t| 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 @@ -137,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")