Merge branch '12194-search-always-valid'
[arvados.git] / 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' ] 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 task :linkchecker => [ :generate ] do
29   Dir.chdir(".site") do
30     `which linkchecker`
31     if $? == 0
32       system "linkchecker index.html --ignore-url='!file://'" or exit $?.exitstatus
33     else
34       puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
35     end
36   end
37 end
38
39 task :clean do
40   rm_rf "sdk/python/arvados"
41 end
42
43 require "zenweb/tasks"
44 load "zenweb-textile.rb"
45 load "zenweb-liquid.rb"
46
47 task :extra_wirings do
48   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")
49 end