doc/Rakefile

   1 #!/usr/bin/env rake
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: CC-BY-SA-3.0
   5
   6 # As a convenience to the documentation writer, you can touch a file
   7 # called 'no-sdk' in the 'doc' directory and it will suppress
   8 # generating the documentation for the SDKs, which (the R docs
   9 # especially) take a fair bit of time and slow down the edit-preview
  10 # cycle.
  11 #
  12 # To generate and view the documentation locally, run this command
  13 #
  14 #   rake && sensible-browser .site/index.html
  15 #
  16 # Or alternatively:
  17 #
  18 #   baseurl=http://localhost:8000 rake && rake run
  19 #
  20 # and then visit http://localhost:8000 in a browser.
  21
  22 require "uri"
  23
  24 require "rubygems"
  25 require "colorize"
  26
  27 def can_run?(*command, **options)
  28   options = {
  29     :in => :close,
  30     :out => [File::NULL, "w"],
  31   }.merge(options)
  32   system(*command, **options)
  33 end
  34
  35 class JavaSDK
  36   def self.build_path
  37     "sdk/java-v2"
  38   end
  39
  40   def self.can_build?
  41     can_run?("gradle", "--version")
  42   end
  43 end
  44
  45 class PythonSDK
  46   def self.build_path
  47     "sdk/python/arvados"
  48   end
  49
  50   def self.can_build?
  51     can_run?("./pysdk_pdoc.py", "--version")
  52   end
  53 end
  54
  55 class RSDK
  56   def self.build_path
  57     "sdk/R"
  58   end
  59
  60   def self.can_build?
  61     can_run?("R", "--version")
  62   end
  63 end
  64
  65 $build_sdks = begin
  66   no_sdk_env = ENV.fetch("NO_SDK", "")
  67   sdks_env = ENV.fetch("sdks", "")
  68   all_sdks = Hash[[JavaSDK, PythonSDK, RSDK].map { |c| [c.name, c] }]
  69
  70   if no_sdk_env != "" and sdks_env != ""
  71     fail "both NO_SDK and sdks defined in environment"
  72   elsif sdks_env != ""
  73     # Nothing to do
  74   elsif no_sdk_env != "" or File.exist?("no-sdk")
  75     sdks_env = "none"
  76   end
  77
  78   if sdks_env == ""
  79     all_sdks.each_pair.filter_map do |name, sdk|
  80       if sdk.can_build?
  81         sdk
  82       else
  83         puts "Warning: cannot build #{name.gsub(/SDK$/, ' SDK')} documentation, skipping".colorize(:light_red)
  84       end
  85     end
  86   else
  87     wanted_sdks = []
  88     sdks_env.split(/\s*[,\s]\s*/).each do |key|
  89       key = "#{key.capitalize}SDK"
  90       if key == "AllSDK"
  91         wanted_sdks = all_sdks.values
  92       elsif key == "NoneSDK"
  93         wanted_sdks.clear
  94       elsif sdk = all_sdks[key]
  95         wanted_sdks << sdk
  96       else
  97         fail "cannot build documentation for unknown #{key}"
  98       end
  99     end
 100     wanted_sdks
 101   end
 102 end
 103
 104 module Zenweb
 105   class Site
 106     @binary_files = %w[png jpg gif eot svg ttf woff2? ico pdf m4a t?gz xlsx]
 107   end
 108 end
 109
 110 task :generate => [ :realclean, 'sdk/python/arvados.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
 111   vars = ['baseurl', 'arvados_cluster_uuid', 'arvados_api_host', 'arvados_workbench_host']
 112   if ! ENV.key?('baseurl') || ENV['baseurl'] == ""
 113     if !ENV.key?('WORKSPACE') || ENV['WORKSPACE'] == ""
 114       puts "The `baseurl` variable was not specified and the `WORKSPACE` environment variable is not set. Defaulting `baseurl` to file://#{pwd}/.site"
 115       ENV['baseurl'] = "file://#{pwd}/.site/"
 116     else
 117       puts "The `baseurl` variable was not specified, defaulting to a value derived from the `WORKSPACE` environment variable"
 118       ENV['baseurl'] = "file://#{ENV['WORKSPACE']}/doc/.site/"
 119     end
 120   end
 121   vars.each do |v|
 122     if ENV[v]
 123       website.config.h[v] = ENV[v]
 124     end
 125   end
 126 end
 127
 128 file ["install/new_cluster_checklist_Azure.xlsx", "install/new_cluster_checklist_AWS.xlsx"] do |t|
 129   cp(t, t)
 130 end
 131
 132 file "sdk/python/arvados.html" do |t|
 133   next unless $build_sdks.include?(PythonSDK)
 134   raise unless system("python3", "setup.py", "build",
 135                       chdir: "../sdk/python", out: :err)
 136   raise unless system("python3", "pysdk_pdoc.py",
 137                       out: :err)
 138 end
 139
 140 file "sdk/R/arvados/index.html" do |t|
 141   next unless $build_sdks.include?(RSDK)
 142   Dir.mkdir("sdk/R")
 143   Dir.mkdir("sdk/R/arvados")
 144   cp('css/R.css', 'sdk/R/arvados')
 145   docnames = Dir.glob("../sdk/R/man/*.Rd").map { |rd| File.basename(rd, ".Rd") }.sort
 146   docnames.each do |basename|
 147     raise unless system(
 148                    "R", "CMD", "Rdconv", "--type=html", "man/#{basename}.Rd",
 149                    chdir: "../sdk/R",
 150                    out: ["sdk/R/arvados/#{basename}.html", "w"],
 151                  )
 152   end
 153
 154   File.open("sdk/R/index.html.md", "w") do |fn|
 155     fn.write(<<-EOF
 156 ---
 157 layout: default
 158 navsection: sdk
 159 navmenu: R
 160 title: "R SDK Overview"
 161 ...
 162
 163 EOF
 164             )
 165     File.open("../sdk/R/README.md", "r") do |rd|
 166       fn.write(rd.read)
 167     end
 168   end
 169
 170   File.open("sdk/R/arvados/index.html.textile.liquid", "w") do |fn|
 171     fn.write(<<-EOF
 172 ---
 173 layout: default
 174 navsection: sdk
 175 navmenu: R
 176 title: "R Reference"
 177 ...
 178 {% comment %}
 179 Copyright (C) The Arvados Authors. All rights reserved.
 180
 181 SPDX-License-Identifier: CC-BY-SA-3.0
 182 {% endcomment %}
 183
 184 EOF
 185             )
 186     docnames.each do |basename|
 187       fn.printf("* \"%s\":%s.html\n", basename, basename)
 188     end
 189   end
 190 end
 191
 192 file "sdk/java-v2/javadoc/index.html" do |t|
 193   next unless $build_sdks.include?(JavaSDK)
 194   tgt = Dir.pwd
 195   docfiles = []
 196   Dir.chdir("../sdk/java-v2") do
 197     STDERR.puts `gradle javadoc 2>&1`
 198     raise if $? != 0
 199     puts `sed -i "s/@import.*dejavu.css.*//g" build/docs/javadoc/stylesheet.css`
 200     raise if $? != 0
 201   end
 202   cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
 203   raise if $? != 0
 204 end
 205
 206 task :linkchecker => [ :generate ] do
 207   # we need --check-extern to check relative links, weird but true
 208   opts = [
 209     "--check-extern",
 210     "--ignore-url=!^file://",
 211   ]
 212   ([JavaSDK, PythonSDK, RSDK] - $build_sdks).map(&:build_path).each do |sdk_path|
 213     sdk_url = URI.join(ENV["baseurl"], sdk_path)
 214     url_re = Regexp.escape(sdk_url.to_s)
 215     opts << "--ignore-url=^#{url_re}[./]"
 216   end
 217   result = system(
 218     "linkchecker", *opts, "index.html",
 219     chdir: ".site",
 220   )
 221   if result.nil?
 222     fail "could not run linkchecker command (is it installed?)"
 223   elsif !result
 224     fail "linkchecker exited #{$?.exitstatus}"
 225   end
 226 end
 227
 228 task :import_vscode_training do
 229   Dir.chdir("user") do
 230   rm_rf "arvados-vscode-cwl-training"
 231   `git clone https://github.com/arvados/arvados-vscode-cwl-training`
 232   githash = `git --git-dir arvados-vscode-cwl-training/.git log -n1 --format=%H HEAD`
 233   File.open("cwl/arvados-vscode-training.html.md.liquid", "w") do |fn|
 234     File.open("arvados-vscode-cwl-training/README.md", "r") do |rd|
 235       fn.write(<<-EOF
 236 ---
 237 layout: default
 238 navsection: userguide
 239 title: "Developing CWL Workflows with VSCode"
 240 ...
 241 {% comment %}
 242 Copyright (C) The Arvados Authors. All rights reserved.
 243
 244 SPDX-License-Identifier: CC-BY-SA-3.0
 245
 246 Imported from https://github.com/arvados/arvados-vscode-cwl-training
 247 git hash: #{githash}
 248 {% endcomment %}
 249
 250 EOF
 251               )
 252                fn.write(rd.read())
 253     end
 254   end
 255   rm_rf "arvados-vscode-cwl-training"
 256   end
 257 end
 258
 259 task :clean do
 260   rm_rf "sdk/python/arvados"
 261   rm_f "sdk/python/arvados.html"
 262   rm_f "sdk/python/index.html"
 263   rm_rf "sdk/R"
 264   rm_rf "sdk/java-v2/javadoc"
 265 end
 266
 267 require "zenweb/tasks"
 268 load "zenweb-textile.rb"
 269 load "zenweb-liquid.rb"
 270 load "zenweb-fix-body.rb"
 271
 272 task :extra_wirings do
 273   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados.html")
 274 end