From 0d26e4190e1c7fe899d7da443e49758aaa5f62d8 Mon Sep 17 00:00:00 2001 From: "Achim D. Brucker" Date: Sat, 25 Aug 2018 00:01:48 +0100 Subject: [PATCH] Enable RDoc generation using rake. --- .gitignore | 3 +++ lib/tasks/rdoc.rake | 16 ++++++++++++++++ test/.empty | 0 3 files changed, 19 insertions(+) create mode 100644 lib/tasks/rdoc.rake create mode 100644 test/.empty diff --git a/.gitignore b/.gitignore index 76cf651..5ae70a8 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,9 @@ # Ignore bundler config. /.bundle +# ignore generated doc +doc/rdocs + # Ignore the default SQLite database. /db/*.sqlite3 /db/*.sqlite3-journal diff --git a/lib/tasks/rdoc.rake b/lib/tasks/rdoc.rake new file mode 100644 index 0000000..cd3aac4 --- /dev/null +++ b/lib/tasks/rdoc.rake @@ -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 + diff --git a/test/.empty b/test/.empty new file mode 100644 index 0000000..e69de29