#
# and then visit http://localhost:8000 in a browser.
+require "uri"
+
require "rubygems"
require "colorize"
+def can_run?(*command, **options)
+ options = {
+ :in => :close,
+ :out => [File::NULL, "w"],
+ }.merge(options)
+ system(*command, **options)
+end
+
+class JavaSDK
+ def self.build_path
+ "sdk/java-v2"
+ end
+
+ def self.can_build?
+ can_run?("gradle", "--version")
+ end
+end
+
+class PythonSDK
+ def self.build_path
+ "sdk/python/arvados"
+ end
+
+ def self.can_build?
+ can_run?("./pysdk_pdoc.py", "--version")
+ end
+end
+
+class RSDK
+ def self.build_path
+ "sdk/R"
+ end
+
+ def self.can_build?
+ can_run?("make", "can_run", chdir: File.join("..", self.build_path))
+ end
+end
+
+$build_sdks = begin
+ no_sdk_env = ENV.fetch("NO_SDK", "")
+ sdks_env = ENV.fetch("sdks", "")
+ all_sdks = Hash[[JavaSDK, PythonSDK, RSDK].map { |c| [c.name, c] }]
+
+ if no_sdk_env != "" and sdks_env != ""
+ fail "both NO_SDK and sdks defined in environment"
+ elsif sdks_env != ""
+ # Nothing to do
+ elsif no_sdk_env != "" or File.exist?("no-sdk")
+ sdks_env = "none"
+ end
+
+ if sdks_env == ""
+ all_sdks.each_pair.filter_map do |name, sdk|
+ if sdk.can_build?
+ sdk
+ else
+ puts "Warning: cannot build #{name.gsub(/SDK$/, ' SDK')} documentation, skipping".colorize(:light_red)
+ end
+ end
+ else
+ wanted_sdks = []
+ sdks_env.split(/\s*[,\s]\s*/).each do |key|
+ key = "#{key.capitalize}SDK"
+ if key == "AllSDK"
+ wanted_sdks = all_sdks.values
+ elsif key == "NoneSDK"
+ wanted_sdks.clear
+ elsif sdk = all_sdks[key]
+ wanted_sdks << sdk
+ else
+ fail "cannot build documentation for unknown #{key}"
+ end
+ end
+ wanted_sdks
+ end
+end
+
module Zenweb
class Site
@binary_files = %w[png jpg gif eot svg ttf woff2? ico pdf m4a t?gz xlsx]
end
file "sdk/python/arvados.html" do |t|
- if ENV['NO_SDK'] || File.exist?("no-sdk")
- next
- end
- # pysdk_pdoc.py is a wrapper around the pdoc CLI. `which pdoc` is an easy
- # and good-enough test to check whether it's installed at all.
- `which pdoc`
- if $? == 0
- raise unless system("python3", "setup.py", "build",
- chdir: "../sdk/python", out: :err)
- raise unless system("python3", "pysdk_pdoc.py",
- out: :err)
- else
- puts "Warning: pdoc not found, Python documentation will not be generated".colorize(:light_red)
- end
+ next unless $build_sdks.include?(PythonSDK)
+ raise unless system("python3", "setup.py", "build",
+ chdir: "../sdk/python", out: :err)
+ raise unless system("python3", "pysdk_pdoc.py",
+ out: :err)
end
file "sdk/R/arvados/index.html" do |t|
- if ENV['NO_SDK'] || File.exist?("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
- Dir.entries("man").each do |rd|
- if rd[-3..-1] == ".Rd"
- htmlfile = "#{rd[0..-4]}.html"
- `R CMD Rdconv -t html man/#{rd} > #{tgt}/sdk/R/arvados/#{htmlfile}`
- docfiles << htmlfile
- end
- end
- end
- raise if $? != 0
+ next unless $build_sdks.include?(RSDK)
+ Dir.mkdir("sdk/R")
+ Dir.mkdir("sdk/R/arvados")
+ cp('css/R.css', 'sdk/R/arvados')
+ raise unless system("make", "man", chdir: "../sdk/R", out: :err)
+ docnames = Dir.glob("../sdk/R/man/*.Rd").map { |rd| File.basename(rd, ".Rd") }.sort
+ docnames.each do |basename|
+ raise unless system(
+ "R", "CMD", "Rdconv", "--type=html", "man/#{basename}.Rd",
+ chdir: "../sdk/R",
+ out: ["sdk/R/arvados/#{basename}.html", "w"],
+ )
+ end
- File.open("../sdk/R/README.md", "r") do |rd|
- File.open("sdk/R/index.html.md", "w") do |fn|
- fn.write(<<-EOF
+ File.open("sdk/R/index.html.md", "w") do |fn|
+ fn.write(<<-EOF
---
layout: default
navsection: sdk
title: "R SDK Overview"
...
-#{rd.read}
EOF
- )
- end
+ )
+ File.open("../sdk/R/README.md", "r") do |rd|
+ fn.write(rd.read)
end
+ end
- File.open("sdk/R/arvados/index.html.textile.liquid", "w") do |fn|
- fn.write(<<-EOF
+ File.open("sdk/R/arvados/index.html.textile.liquid", "w") do |fn|
+ fn.write(<<-EOF
---
layout: default
navsection: sdk
{% endcomment %}
EOF
- )
-
- docfiles.sort.each do |d|
- fn.write("* \"#{d[0..-6]}\":#{d}\n")
- end
-
+ )
+ docnames.each do |basename|
+ fn.printf("* \"%s\":%s.html\n", basename, basename)
end
- else
- puts "Warning: R not found, R documentation will not be generated".colorize(:light_red)
end
end
file "sdk/java-v2/javadoc/index.html" do |t|
- if ENV['NO_SDK'] || File.exist?("no-sdk")
- next
- end
- `which java`
- if $? == 0
- `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
- else
- puts "Warning: java not found, java sdk documentation will not be generated".colorize(:light_red)
+ next unless $build_sdks.include?(JavaSDK)
+ 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
task :linkchecker => [ :generate ] do
- Dir.chdir(".site") do
- `which linkchecker`
- if $? == 0
- # we need --check-extern to check relative links, weird but true
- system "linkchecker index.html --check-extern --ignore-url='!file://'" or exit $?.exitstatus
- else
- puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
- end
+ # we need --check-extern to check relative links, weird but true
+ opts = [
+ "--check-extern",
+ "--ignore-url=!^file://",
+ ]
+ ([JavaSDK, PythonSDK, RSDK] - $build_sdks).map(&:build_path).each do |sdk_path|
+ sdk_url = URI.join(ENV["baseurl"], sdk_path)
+ url_re = Regexp.escape(sdk_url.to_s)
+ opts << "--ignore-url=^#{url_re}[./]"
+ end
+ result = system(
+ "linkchecker", *opts, "index.html",
+ chdir: ".site",
+ )
+ if result.nil?
+ fail "could not run linkchecker command (is it installed?)"
+ elsif !result
+ fail "linkchecker exited #{$?.exitstatus}"
end
end
projects / arvados.git / blobdiff