17344: Link next steps to appropriate doc pages.
[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 # 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.exists?("no-sdk")
55     next
56   end
57   `which pdoc`
58   if $? == 0
59     STDERR.puts `pdoc --html -o sdk/python ../sdk/python/arvados/ 2>&1`
60     raise if $? != 0
61   else
62     puts "Warning: pdoc3 not found, Python documentation will not be generated".colorize(:light_red)
63   end
64 end
65
66 file "sdk/R/arvados/index.html" do |t|
67   if ENV['NO_SDK'] || File.exists?("no-sdk")
68     next
69   end
70   `which R`
71   if $? == 0
72     tgt = Dir.pwd
73     Dir.mkdir("sdk/R")
74     Dir.mkdir("sdk/R/arvados")
75     puts("tgt", tgt)
76     cp('css/R.css', 'sdk/R/arvados')
77     docfiles = []
78     Dir.chdir("../sdk/R/") do
79       STDERR.puts `Rscript createDoc.R README.Rmd #{tgt}/sdk/R/README.md 2>&1`
80       Dir.entries("man").each do |rd|
81         if rd[-3..-1] == ".Rd"
82           htmlfile = "#{rd[0..-4]}.html"
83           `R CMD Rdconv -t html man/#{rd} > #{tgt}/sdk/R/arvados/#{htmlfile}`
84           docfiles << htmlfile
85         end
86       end
87     end
88     raise if $? != 0
89
90     File.open("sdk/R/README.md", "r") do |rd|
91     File.open("sdk/R/index.html.md", "w") do |fn|
92       fn.write(<<-EOF
93 ---
94 layout: default
95 navsection: sdk
96 navmenu: R
97 title: "R SDK Overview"
98 ...
99
100 #{rd.read.gsub(/^```$/, "~~~").gsub(/^```(\w)$/, "~~~\\1")}
101 EOF
102               )
103       end
104     end
105
106     File.open("sdk/R/arvados/index.html.textile.liquid", "w") do |fn|
107       fn.write(<<-EOF
108 ---
109 layout: default
110 navsection: sdk
111 navmenu: R
112 title: "R Reference"
113 ...
114 {% comment %}
115 Copyright (C) The Arvados Authors. All rights reserved.
116
117 SPDX-License-Identifier: CC-BY-SA-3.0
118 {% endcomment %}
119
120 EOF
121               )
122
123       docfiles.sort.each do |d|
124         fn.write("* \"#{d[0..-6]}\":#{d}\n")
125       end
126
127     end
128   else
129     puts "Warning: R not found, R documentation will not be generated".colorize(:light_red)
130   end
131 end
132
133 file "sdk/java-v2/javadoc/index.html" do |t|
134   if ENV['NO_SDK'] || File.exists?("no-sdk")
135     next
136   end
137   `which java`
138   if $? == 0
139     `which gradle`
140     if $? != 0
141       puts "Warning: gradle not found, java sdk documentation will not be generated".colorize(:light_red)
142     else
143       tgt = Dir.pwd
144       docfiles = []
145       Dir.chdir("../sdk/java-v2") do
146         STDERR.puts `gradle javadoc 2>&1`
147         raise if $? != 0
148         puts `sed -i "s/@import.*dejavu.css.*//g" build/docs/javadoc/stylesheet.css`
149         raise if $? != 0
150       end
151       cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
152       raise if $? != 0
153     end
154   else
155     puts "Warning: java not found, java sdk documentation will not be generated".colorize(:light_red)
156   end
157 end
158
159 task :linkchecker => [ :generate ] do
160   Dir.chdir(".site") do
161     `which linkchecker`
162     if $? == 0
163       # we need --check-extern to check relative links, weird but true
164       system "linkchecker index.html --check-extern --ignore-url='!file://'" or exit $?.exitstatus
165     else
166       puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
167     end
168   end
169 end
170
171 task :import_vscode_training do
172   Dir.chdir("user") do
173   rm_rf "arvados-vscode-cwl-training"
174   `git clone https://github.com/arvados/arvados-vscode-cwl-training`
175   githash = `git --git-dir arvados-vscode-cwl-training/.git log -n1 --format=%H HEAD`
176   File.open("cwl/arvados-vscode-training.html.md.liquid", "w") do |fn|
177     File.open("arvados-vscode-cwl-training/README.md", "r") do |rd|
178       fn.write(<<-EOF
179 ---
180 layout: default
181 navsection: userguide
182 title: "Developing CWL Workflows with VSCode"
183 ...
184 {% comment %}
185 Copyright (C) The Arvados Authors. All rights reserved.
186
187 SPDX-License-Identifier: CC-BY-SA-3.0
188
189 Imported from https://github.com/arvados/arvados-vscode-cwl-training
190 git hash: #{githash}
191 {% endcomment %}
192
193 EOF
194               )
195                fn.write(rd.read())
196     end
197   end
198   rm_rf "arvados-vscode-cwl-training"
199   end
200 end
201
202 task :clean do
203   rm_rf "sdk/python/arvados"
204   rm_rf "sdk/R"
205   rm_rf "sdk/java-v2/javadoc"
206 end
207
208 require "zenweb/tasks"
209 load "zenweb-textile.rb"
210 load "zenweb-liquid.rb"
211 load "zenweb-fix-body.rb"
212
213 task :extra_wirings do
214   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")
215 end