From e1e96c0cf480930f33dcb4355f38244319ce0e37 Mon Sep 17 00:00:00 2001 From: David Siaw Date: Mon, 26 Aug 2019 00:23:28 +0900 Subject: change doc directory and reduce warnings --- tasks/doc.rake | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 tasks/doc.rake (limited to 'tasks') diff --git a/tasks/doc.rake b/tasks/doc.rake new file mode 100644 index 000000000..ab34b33b1 --- /dev/null +++ b/tasks/doc.rake @@ -0,0 +1,38 @@ +desc 'generate document' +task :doc => [:api_doc, :capi_doc] do + +end + +desc 'generate yard docs' +task :api_doc do + begin + sh "mrbdoc" + rescue + puts "ERROR: To generate yard documentation, you should install yard-mruby gem." + puts " $ gem install yard-mruby yard-coderay" + end +end + +desc 'generate doxygen docs' +task :capi_doc do + begin + sh "doxygen Doxyfile" + rescue + puts "ERROR: To generate C API documents, you need Doxygen." + puts " $ sudo apt-get install doxygen" + end +end + +desc 'clean all built docs' +task :clean_api_doc do + FileUtils.rm_rf 'doc/api' +end + +desc 'clean all built docs' +task :clean_capi_doc do + FileUtils.rm_rf 'doc/capi' +end + +desc 'clean all built docs' +task :clean_doc => [:clean_api_doc, :clean_capi_doc] do +end -- cgit v1.2.3