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 require "rubygems"
   7 require "colorize"
   8
   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']
  11   vars.each do |v|
  12     if ENV[v]
  13       website.config.h[v] = ENV[v]
  14     end
  15   end
  16 end
  17
  18 file "sdk/python/arvados/index.html" do |t|
  19   if File.exists? "no-sdk"
  20     next
  21   end
  22   `which epydoc`
  23   if $? == 0
  24     STDERR.puts `epydoc --html --parse-only -o sdk/python/arvados ../sdk/python/arvados/ 2>&1`
  25     raise if $? != 0
  26   else
  27     puts "Warning: epydoc not found, Python documentation will not be generated".colorize(:light_red)
  28   end
  29 end
  30
  31 file "sdk/R/arvados/index.html" do |t|
  32   if File.exists? "no-sdk"
  33     next
  34   end
  35   `which R`
  36   if $? == 0
  37     tgt = Dir.pwd
  38     Dir.mkdir("sdk/R")
  39     Dir.mkdir("sdk/R/arvados")
  40     docfiles = []
  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}`
  47           docfiles << htmlfile
  48         end
  49       end
  50     end
  51     raise if $? != 0
  52
  53     File.open("sdk/R/README.md", "r") do |rd|
  54     File.open("sdk/R/index.html.md", "w") do |fn|
  55       fn.write(<<-EOF
  56 ---
  57 layout: default
  58 navsection: sdk
  59 navmenu: R
  60 title: "R SDK Overview"
  61 ...
  62
  63 #{rd.read.gsub(/^```$/, "~~~").gsub(/^```(\w)$/, "~~~\\1")}
  64 EOF
  65               )
  66       end
  67     end
  68
  69     File.open("sdk/R/arvados/index.html.textile.liquid", "w") do |fn|
  70       fn.write(<<-EOF
  71 ---
  72 layout: default
  73 navsection: sdk
  74 navmenu: R
  75 title: "R Reference"
  76 ...
  77 {% comment %}
  78 Copyright (C) The Arvados Authors. All rights reserved.
  79
  80 SPDX-License-Identifier: CC-BY-SA-3.0
  81 {% endcomment %}
  82
  83 EOF
  84               )
  85
  86       docfiles.sort.each do |d|
  87         fn.write("* \"#{d[0..-6]}\":#{d}\n")
  88       end
  89
  90     end
  91   else
  92     puts "Warning: R not found, R documentation will not be generated".colorize(:light_red)
  93   end
  94 end
  95
  96 file "sdk/java-v2/javadoc/index.html" do |t|
  97   if File.exists? "no-sdk"
  98     next
  99   end
 100   `which java`
 101   if $? == 0
 102     `which gradle`
 103     if $? != 0
 104       puts "Warning: gradle not found, java sdk documentation will not be generated".colorize(:light_red)
 105     else
 106       tgt = Dir.pwd
 107       docfiles = []
 108       Dir.chdir("../sdk/java-v2") do
 109         STDERR.puts `gradle javadoc 2>&1`
 110         raise if $? != 0
 111       end
 112       cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
 113       raise if $? != 0
 114     end
 115   else
 116     puts "Warning: java not found, java sdk documentation will not be generated".colorize(:light_red)
 117   end
 118 end
 119
 120 task :linkchecker => [ :generate ] do
 121   Dir.chdir(".site") do
 122     `which linkchecker`
 123     if $? == 0
 124       system "linkchecker index.html --ignore-url='!file://'" or exit $?.exitstatus
 125     else
 126       puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
 127     end
 128   end
 129 end
 130
 131 task :clean do
 132   rm_rf "sdk/python/arvados"
 133   rm_rf "sdk/R"
 134   rm_rf "sdk/java-v2/javadoc"
 135 end
 136
 137 require "zenweb/tasks"
 138 load "zenweb-textile.rb"
 139 load "zenweb-liquid.rb"
 140
 141 task :extra_wirings do
 142   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")
 143 end