Enable RDoc generation using rake.

This commit is contained in:
Achim D. Brucker 2018-08-25 00:01:48 +01:00
parent e5e4254041
commit 0d26e4190e
3 changed files with 19 additions and 0 deletions

3
.gitignore vendored
View File

@ -7,6 +7,9 @@
# Ignore bundler config.
/.bundle
# ignore generated doc
doc/rdocs
# Ignore the default SQLite database.
/db/*.sqlite3
/db/*.sqlite3-journal

16
lib/tasks/rdoc.rake Normal file
View File

@ -0,0 +1,16 @@
require 'rdoc/task'
desc 'generate API documentation to doc/rdocs/index.html'
Rake::RDocTask.new do |rd|
rd.rdoc_dir = 'doc/rdocs'
rd.main = 'README.md'
rd.rdoc_files.include 'README.md', "config/**/*\.rb", "helpers/**/*\.rb", "script/**/*\.rb"
rd.options << '--inline-source'
rd.options << '--line-numbers'
rd.options << '--all'
rd.options << '--fileboxes'
rd.options << '--diagram'
end

0
test/.empty Normal file
View File