X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d63eaa465e157dd289a80738c5da83edaf03e784..0ea9427622c1f4179c7324cb57b0d6d2aa4970b6:/doc/Rakefile diff --git a/doc/Rakefile b/doc/Rakefile index 2b4b6af2e0..89454940c7 100644 --- a/doc/Rakefile +++ b/doc/Rakefile @@ -51,20 +51,22 @@ file ["install/new_cluster_checklist_Azure.xlsx", "install/new_cluster_checklist end file "sdk/python/arvados/index.html" do |t| - if ENV['NO_SDK'] || File.exists?("no-sdk") + if ENV['NO_SDK'] || File.exist?("no-sdk") next end `which pdoc` if $? == 0 - STDERR.puts `pdoc --html -o sdk/python ../sdk/python/arvados/ 2>&1` - raise if $? != 0 + raise unless system("python3", "setup.py", "build", + chdir: "../sdk/python", out: :err) + raise unless system("pdoc", "--html", "-o", "sdk/python", "../sdk/python/build/lib/arvados/", + out: :err) else puts "Warning: pdoc3 not found, Python documentation will not be generated".colorize(:light_red) end end file "sdk/R/arvados/index.html" do |t| - if ENV['NO_SDK'] || File.exists?("no-sdk") + if ENV['NO_SDK'] || File.exist?("no-sdk") next end `which R` @@ -76,7 +78,6 @@ file "sdk/R/arvados/index.html" do |t| cp('css/R.css', 'sdk/R/arvados') docfiles = [] Dir.chdir("../sdk/R/") do - STDERR.puts `Rscript createDoc.R README.Rmd #{tgt}/sdk/R/README.md 2>&1` Dir.entries("man").each do |rd| if rd[-3..-1] == ".Rd" htmlfile = "#{rd[0..-4]}.html" @@ -87,7 +88,7 @@ file "sdk/R/arvados/index.html" do |t| end raise if $? != 0 - File.open("sdk/R/README.md", "r") do |rd| + File.open("../sdk/R/README.md", "r") do |rd| File.open("sdk/R/index.html.md", "w") do |fn| fn.write(<<-EOF --- @@ -97,7 +98,7 @@ navmenu: R title: "R SDK Overview" ... -#{rd.read.gsub(/^```$/, "~~~").gsub(/^```(\w)$/, "~~~\\1")} +#{rd.read} EOF ) end @@ -131,7 +132,7 @@ EOF end file "sdk/java-v2/javadoc/index.html" do |t| - if ENV['NO_SDK'] || File.exists?("no-sdk") + if ENV['NO_SDK'] || File.exist?("no-sdk") next end `which java` @@ -160,7 +161,8 @@ task :linkchecker => [ :generate ] do Dir.chdir(".site") do `which linkchecker` if $? == 0 - system "linkchecker index.html --ignore-url='!file://'" or exit $?.exitstatus + # we need --check-extern to check relative links, weird but true + system "linkchecker index.html --check-extern --ignore-url='!file://'" or exit $?.exitstatus else puts "Warning: linkchecker not found, skipping run".colorize(:light_red) end