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 "rubygems"
  23 require "colorize"
  24
  25 module Zenweb
  26   class Site
  27     @binary_files = %w[png jpg gif eot svg ttf woff2? ico pdf m4a t?gz xlsx]
  28   end
  29 end
  30
  31 task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
  32   vars = ['baseurl', 'arvados_cluster_uuid', 'arvados_api_host', 'arvados_workbench_host']
  33   if ! ENV.key?('baseurl') || ENV['baseurl'] == ""
  34     if !ENV.key?('WORKSPACE') || ENV['WORKSPACE'] == ""
  35       puts "The `baseurl` variable was not specified and the `WORKSPACE` environment variable is not set. Defaulting `baseurl` to file://#{pwd}/.site"
  36       ENV['baseurl'] = "file://#{pwd}/.site/"
  37     else
  38       puts "The `baseurl` variable was not specified, defaulting to a value derived from the `WORKSPACE` environment variable"
  39       ENV['baseurl'] = "file://#{ENV['WORKSPACE']}/doc/.site/"
  40     end
  41   end
  42   vars.each do |v|
  43     if ENV[v]
  44       website.config.h[v] = ENV[v]
  45     end
  46   end
  47 end
  48
  49 file ["install/new_cluster_checklist_Azure.xlsx", "install/new_cluster_checklist_AWS.xlsx"] do |t|
  50   cp(t, t)
  51 end
  52
  53 file "sdk/python/arvados/index.html" do |t|
  54   if ENV['NO_SDK'] || File.exist?("no-sdk")
  55     next
  56   end
  57   `which pdoc`
  58   if $? == 0
  59     raise unless system("python3", "setup.py", "build",
  60                         chdir: "../sdk/python", out: :err)
  61     raise unless system("pdoc", "--html", "-o", "sdk/python", "../sdk/python/build/lib/arvados/",
  62                         out: :err)
  63   else
  64     puts "Warning: pdoc3 not found, Python documentation will not be generated".colorize(:light_red)
  65   end
  66 end
  67
  68 file "sdk/R/arvados/index.html" do |t|
  69   if ENV['NO_SDK'] || File.exist?("no-sdk")
  70     next
  71   end
  72   `which R`
  73   if $? == 0
  74     tgt = Dir.pwd
  75     Dir.mkdir("sdk/R")
  76     Dir.mkdir("sdk/R/arvados")
  77     puts("tgt", tgt)
  78     cp('css/R.css', 'sdk/R/arvados')
  79     docfiles = []
  80     Dir.chdir("../sdk/R/") do
  81       Dir.entries("man").each do |rd|
  82         if rd[-3..-1] == ".Rd"
  83           htmlfile = "#{rd[0..-4]}.html"
  84           `R CMD Rdconv -t html man/#{rd} > #{tgt}/sdk/R/arvados/#{htmlfile}`
  85           docfiles << htmlfile
  86         end
  87       end
  88     end
  89     raise if $? != 0
  90
  91     File.open("../sdk/R/README.md", "r") do |rd|
  92     File.open("sdk/R/index.html.md", "w") do |fn|
  93       fn.write(<<-EOF
  94 ---
  95 layout: default
  96 navsection: sdk
  97 navmenu: R
  98 title: "R SDK Overview"
  99 ...
 100
 101 #{rd.read}
 102 EOF
 103               )
 104       end
 105     end
 106
 107     File.open("sdk/R/arvados/index.html.textile.liquid", "w") do |fn|
 108       fn.write(<<-EOF
 109 ---
 110 layout: default
 111 navsection: sdk
 112 navmenu: R
 113 title: "R Reference"
 114 ...
 115 {% comment %}
 116 Copyright (C) The Arvados Authors. All rights reserved.
 117
 118 SPDX-License-Identifier: CC-BY-SA-3.0
 119 {% endcomment %}
 120
 121 EOF
 122               )
 123
 124       docfiles.sort.each do |d|
 125         fn.write("* \"#{d[0..-6]}\":#{d}\n")
 126       end
 127
 128     end
 129   else
 130     puts "Warning: R not found, R documentation will not be generated".colorize(:light_red)
 131   end
 132 end
 133
 134 file "sdk/java-v2/javadoc/index.html" do |t|
 135   if ENV['NO_SDK'] || File.exist?("no-sdk")
 136     next
 137   end
 138   `which java`
 139   if $? == 0
 140     `which gradle`
 141     if $? != 0
 142       puts "Warning: gradle not found, java sdk documentation will not be generated".colorize(:light_red)
 143     else
 144       tgt = Dir.pwd
 145       docfiles = []
 146       Dir.chdir("../sdk/java-v2") do
 147         STDERR.puts `gradle javadoc 2>&1`
 148         raise if $? != 0
 149         puts `sed -i "s/@import.*dejavu.css.*//g" build/docs/javadoc/stylesheet.css`
 150         raise if $? != 0
 151       end
 152       cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
 153       raise if $? != 0
 154     end
 155   else
 156     puts "Warning: java not found, java sdk documentation will not be generated".colorize(:light_red)
 157   end
 158 end
 159
 160 task :linkchecker => [ :generate ] do
 161   Dir.chdir(".site") do
 162     `which linkchecker`
 163     if $? == 0
 164       # we need --check-extern to check relative links, weird but true
 165       system "linkchecker index.html --check-extern --ignore-url='!file://'" or exit $?.exitstatus
 166     else
 167       puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
 168     end
 169   end
 170 end
 171
 172 task :import_vscode_training do
 173   Dir.chdir("user") do
 174   rm_rf "arvados-vscode-cwl-training"
 175   `git clone https://github.com/arvados/arvados-vscode-cwl-training`
 176   githash = `git --git-dir arvados-vscode-cwl-training/.git log -n1 --format=%H HEAD`
 177   File.open("cwl/arvados-vscode-training.html.md.liquid", "w") do |fn|
 178     File.open("arvados-vscode-cwl-training/README.md", "r") do |rd|
 179       fn.write(<<-EOF
 180 ---
 181 layout: default
 182 navsection: userguide
 183 title: "Developing CWL Workflows with VSCode"
 184 ...
 185 {% comment %}
 186 Copyright (C) The Arvados Authors. All rights reserved.
 187
 188 SPDX-License-Identifier: CC-BY-SA-3.0
 189
 190 Imported from https://github.com/arvados/arvados-vscode-cwl-training
 191 git hash: #{githash}
 192 {% endcomment %}
 193
 194 EOF
 195               )
 196                fn.write(rd.read())
 197     end
 198   end
 199   rm_rf "arvados-vscode-cwl-training"
 200   end
 201 end
 202
 203 task :clean do
 204   rm_rf "sdk/python/arvados"
 205   rm_rf "sdk/R"
 206   rm_rf "sdk/java-v2/javadoc"
 207 end
 208
 209 require "zenweb/tasks"
 210 load "zenweb-textile.rb"
 211 load "zenweb-liquid.rb"
 212 load "zenweb-fix-body.rb"
 213
 214 task :extra_wirings do
 215   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")
 216 end