# generating the documentation for the SDKs, which (the R docs
# especially) take a fair bit of time and slow down the edit-preview
# cycle.
+#
+# To generate and view the documentation locally, run this command
+#
+# rake && sensible-browser .site/index.html
+#
+# Or alternatively:
+#
+# baseurl=http://localhost:8000 rake && rake run
+#
+# and then visit http://localhost:8000 in a browser.
require "rubygems"
require "colorize"
-task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
+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.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
vars = ['baseurl', 'arvados_cluster_uuid', 'arvados_api_host', 'arvados_workbench_host']
+ if ! ENV.key?('baseurl') || ENV['baseurl'] == ""
+ if !ENV.key?('WORKSPACE') || ENV['WORKSPACE'] == ""
+ puts "The `baseurl` variable was not specified and the `WORKSPACE` environment variable is not set. Defaulting `baseurl` to file://#{pwd}/.site"
+ ENV['baseurl'] = "file://#{pwd}/.site/"
+ else
+ puts "The `baseurl` variable was not specified, defaulting to a value derived from the `WORKSPACE` environment variable"
+ ENV['baseurl'] = "file://#{ENV['WORKSPACE']}/doc/.site/"
+ end
+ end
vars.each do |v|
if ENV[v]
website.config.h[v] = ENV[v]
end
end
-file "sdk/python/arvados/index.html" do |t|
- if File.exists? "no-sdk"
+file ["install/new_cluster_checklist_Azure.xlsx", "install/new_cluster_checklist_AWS.xlsx"] do |t|
+ cp(t, t)
+end
+
+file "sdk/python/arvados.html" do |t|
+ if ENV['NO_SDK'] || File.exist?("no-sdk")
next
end
- `which epydoc`
+ # 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
- STDERR.puts `epydoc --html --parse-only -o sdk/python/arvados ../sdk/python/arvados/ 2>&1`
- raise 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: epydoc not found, Python documentation will not be generated".colorize(:light_red)
+ puts "Warning: pdoc 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.exist?("no-sdk")
next
end
`which R`
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`
Dir.entries("man").each do |rd|
if rd[-3..-1] == ".Rd"
htmlfile = "#{rd[0..-4]}.html"
end
raise if $? != 0
- File.open("sdk/R/README.md", "r") do |rd|
+ File.open("../sdk/R/README.md", "r") do |rd|
File.open("sdk/R/index.html.md", "w") do |fn|
fn.write(<<-EOF
---
title: "R SDK Overview"
...
-#{rd.read.gsub(/^```$/, "~~~").gsub(/^```(\w)$/, "~~~\\1")}
+#{rd.read}
EOF
)
end
end
file "sdk/java-v2/javadoc/index.html" do |t|
- if File.exists? "no-sdk"
+ if ENV['NO_SDK'] || File.exist?("no-sdk")
next
end
`which java`
Dir.chdir(".site") do
`which linkchecker`
if $? == 0
- system "linkchecker index.html --ignore-url='!file://'" or exit $?.exitstatus
+ # 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
end
end
+task :import_vscode_training do
+ Dir.chdir("user") do
+ rm_rf "arvados-vscode-cwl-training"
+ `git clone https://github.com/arvados/arvados-vscode-cwl-training`
+ githash = `git --git-dir arvados-vscode-cwl-training/.git log -n1 --format=%H HEAD`
+ File.open("cwl/arvados-vscode-training.html.md.liquid", "w") do |fn|
+ File.open("arvados-vscode-cwl-training/README.md", "r") do |rd|
+ fn.write(<<-EOF
+---
+layout: default
+navsection: userguide
+title: "Developing CWL Workflows with VSCode"
+...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+
+Imported from https://github.com/arvados/arvados-vscode-cwl-training
+git hash: #{githash}
+{% endcomment %}
+
+EOF
+ )
+ fn.write(rd.read())
+ end
+ end
+ rm_rf "arvados-vscode-cwl-training"
+ end
+end
+
task :clean do
rm_rf "sdk/python/arvados"
+ rm_f "sdk/python/arvados.html"
+ rm_f "sdk/python/index.html"
rm_rf "sdk/R"
rm_rf "sdk/java-v2/javadoc"
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")
+ $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados.html")
end