2 # Copyright (C) The Arvados Authors. All rights reserved.
4 # SPDX-License-Identifier: CC-BY-SA-3.0
9 task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
10 vars = ['baseurl', 'arvados_cluster_uuid', 'arvados_api_host', 'arvados_workbench_host']
13 website.config.h[v] = ENV[v]
18 file "sdk/python/arvados/index.html" do |t|
19 if File.exists? "no-sdk"
24 STDERR.puts `epydoc --html --parse-only -o sdk/python/arvados ../sdk/python/arvados/ 2>&1`
27 puts "Warning: epydoc not found, Python documentation will not be generated".colorize(:light_red)
31 file "sdk/R/arvados/index.html" do |t|
32 if File.exists? "no-sdk"
39 Dir.mkdir("sdk/R/arvados")
41 Dir.chdir("../sdk/R/") do
42 STDERR.puts `Rscript createDoc.R README.Rmd #{tgt}/sdk/R/README.md 2>&1`
43 Dir.entries("man").each do |rd|
44 if rd[-3..-1] == ".Rd"
45 htmlfile = "#{rd[0..-4]}.html"
46 `R CMD Rdconv -t html man/#{rd} > #{tgt}/sdk/R/arvados/#{htmlfile}`
53 File.open("sdk/R/README.md", "r") do |rd|
54 File.open("sdk/R/index.html.md", "w") do |fn|
60 title: "R SDK Overview"
63 #{rd.read.gsub(/^```$/, "~~~").gsub(/^```(\w)$/, "~~~\\1")}
69 File.open("sdk/R/arvados/index.html.textile.liquid", "w") do |fn|
78 Copyright (C) The Arvados Authors. All rights reserved.
80 SPDX-License-Identifier: CC-BY-SA-3.0
86 docfiles.sort.each do |d|
87 fn.write("* \"#{d[0..-6]}\":#{d}\n")
92 puts "Warning: R not found, R documentation will not be generated".colorize(:light_red)
96 file "sdk/java-v2/javadoc/index.html" do |t|
97 if File.exists? "no-sdk"
104 puts "Warning: gradle not found, java sdk documentation will not be generated".colorize(:light_red)
108 Dir.chdir("../sdk/java-v2") do
109 STDERR.puts `gradle javadoc 2>&1`
112 cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
116 puts "Warning: java not found, java sdk documentation will not be generated".colorize(:light_red)
120 task :linkchecker => [ :generate ] do
121 Dir.chdir(".site") do
124 system "linkchecker index.html --ignore-url='!file://'" or exit $?.exitstatus
126 puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
132 rm_rf "sdk/python/arvados"
134 rm_rf "sdk/java-v2/javadoc"
137 require "zenweb/tasks"
138 load "zenweb-textile.rb"
139 load "zenweb-liquid.rb"
141 task :extra_wirings do
142 $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")