Enable RDoc generation using rake.
This commit is contained in:
parent
e5e4254041
commit
0d26e4190e
|
@ -7,6 +7,9 @@
|
|||
# Ignore bundler config.
|
||||
/.bundle
|
||||
|
||||
# ignore generated doc
|
||||
doc/rdocs
|
||||
|
||||
# Ignore the default SQLite database.
|
||||
/db/*.sqlite3
|
||||
/db/*.sqlite3-journal
|
||||
|
|
|
@ -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
|
||||
|
Loading…
Reference in New Issue