Last change
on this file since 439 was 439, checked in by coas-nagasima, 4 years ago |
mrubyを2.1.1に更新
|
-
Property svn:eol-style
set to
native
-
Property svn:mime-type
set to
text/x-ruby;charset=UTF-8
|
File size:
948 bytes
|
Rev | Line | |
---|
[439] | 1 | desc 'generate document'
|
---|
| 2 | task :doc => [:api_doc, :capi_doc] do
|
---|
| 3 |
|
---|
| 4 | end
|
---|
| 5 |
|
---|
| 6 | desc 'generate yard docs'
|
---|
| 7 | task :api_doc do
|
---|
| 8 | begin
|
---|
| 9 | sh "mrbdoc"
|
---|
| 10 | rescue
|
---|
| 11 | puts "ERROR: To generate yard documentation, you should install yard-mruby gem."
|
---|
| 12 | puts " $ gem install yard-mruby yard-coderay"
|
---|
| 13 | end
|
---|
| 14 | end
|
---|
| 15 |
|
---|
| 16 | desc 'generate doxygen docs'
|
---|
| 17 | task :capi_doc do
|
---|
| 18 | begin
|
---|
| 19 | sh "doxygen Doxyfile"
|
---|
| 20 | rescue
|
---|
| 21 | puts "ERROR: To generate C API documents, you need Doxygen."
|
---|
| 22 | puts " $ sudo apt-get install doxygen"
|
---|
| 23 | end
|
---|
| 24 | end
|
---|
| 25 |
|
---|
| 26 | desc 'clean all built docs'
|
---|
| 27 | task :clean_api_doc do
|
---|
| 28 | rm_rf 'doc/api'
|
---|
| 29 | end
|
---|
| 30 |
|
---|
| 31 | desc 'clean all built docs'
|
---|
| 32 | task :clean_capi_doc do
|
---|
| 33 | rm_rf 'doc/capi'
|
---|
| 34 | end
|
---|
| 35 |
|
---|
| 36 | desc 'clean all built docs'
|
---|
| 37 | task :clean_doc => [:clean_api_doc, :clean_capi_doc] do
|
---|
| 38 | end
|
---|
| 39 |
|
---|
| 40 | desc 'clean all built docs'
|
---|
| 41 | task :view_api => [:api_doc] do
|
---|
| 42 | sh 'xdg-open doc/api/index.html'
|
---|
| 43 | end
|
---|
| 44 |
|
---|
| 45 | desc 'clean all built docs'
|
---|
| 46 | task :view_capi => [:capi_doc] do
|
---|
| 47 | sh 'xdg-open doc/capi/html/index.html'
|
---|
| 48 | end
|
---|
Note:
See
TracBrowser
for help on using the repository browser.