X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/689901263ebfdd996da3711236615038e6245db3..6d95130da47af9fd0290d3c8f80a0364faf74957:/doc/Rakefile?ds=sidebyside diff --git a/doc/Rakefile b/doc/Rakefile index 35bd1a5da7..63dc16d25d 100644 --- a/doc/Rakefile +++ b/doc/Rakefile @@ -3,11 +3,16 @@ # # 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" -#task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do -task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do +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| if ENV[v] @@ -17,6 +22,9 @@ task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/java-v2/ja 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` @@ -27,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 @@ -89,6 +100,9 @@ EOF end file "sdk/java-v2/javadoc/index.html" do |t| + if File.exists? "no-sdk" + next + end `which java` if $? == 0 `which gradle`