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' ] do
  10   vars = ['baseurl', '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   `which epydoc`
  20   if $? == 0
  21     STDERR.puts `epydoc --html --parse-only -o sdk/python/arvados ../sdk/python/arvados/ 2>&1`
  22     raise if $? != 0
  23   else
  24     puts "Warning: epydoc not found, Python documentation will not be generated".colorize(:light_red)
  25   end
  26 end
  27
  28 file "sdk/R/arvados/index.html" do |t|
  29   `which R`
  30   if $? == 0
  31     Dir.chdir("../sdk/R/") do
  32       STDERR.puts `R --quiet --vanilla -e 'pkgdown::build_site()' 2>&1`
  33     end
  34     raise if $? != 0
  35     cp_r("../sdk/R/docs", "sdk/R/arvados")
  36   else
  37     puts "Warning: R not found, R documentation will not be generated".colorize(:light_red)
  38   end
  39 end
  40
  41 task :linkchecker => [ :generate ] do
  42   Dir.chdir(".site") do
  43     `which linkchecker`
  44     if $? == 0
  45       system "linkchecker index.html --ignore-url='!file://'" or exit $?.exitstatus
  46     else
  47       puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
  48     end
  49   end
  50 end
  51
  52 task :clean do
  53   rm_rf "sdk/python/arvados"
  54   rm_rf "sdk/R/arvados"
  55   rm_rf "../sdk/R/docs"
  56 end
  57
  58 require "zenweb/tasks"
  59 load "zenweb-textile.rb"
  60 load "zenweb-liquid.rb"
  61
  62 task :extra_wirings do
  63   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")
  64 end