Permalink
Browse files

Refactor RDoc creation and options in Rakefiles

This should fix the problem of gems not having the correct RDoc options.

The directory structure is changing so that RDoc is now stored in rdoc
instead of doc/rdoc.  This is because doc is now going to hold
additional documentation files.
  • Loading branch information...
1 parent 60d6a54 commit d1fadee1ca7d556ea103733cbcaa0abc513e8698 @jeremyevans committed May 22, 2008
Showing with 13 additions and 14 deletions.
  1. +1 −1 .gitignore
  2. +3 −3 Rakefile
  3. +4 −5 sequel/Rakefile
  4. +5 −5 sequel_core/Rakefile
View
@@ -1,3 +1,3 @@
sequel_core/spec/spec_config.rb
-doc
+rdoc
pkg
View
@@ -68,7 +68,7 @@ end
RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source"]
Rake::RDocTask.new do |rdoc|
- rdoc.rdoc_dir = "doc/rdoc"
+ rdoc.rdoc_dir = "rdoc"
rdoc.options += RDOC_OPTS
rdoc.main = "sequel_core/README"
rdoc.title = "Sequel: The Database Toolkit for Ruby"
@@ -78,8 +78,8 @@ end
desc "Update docs and upload to rubyforge.org"
task :doc_rforge => [:rdoc]
task :doc_rforge do
- sh %{chmod -R g+w doc/rdoc/*}
- sh %{scp -rp doc/rdoc/* rubyforge.org:/var/www/gforge-projects/sequel}
+ sh %{chmod -R g+w rdoc/*}
+ sh %{scp -rp rdoc/* rubyforge.org:/var/www/gforge-projects/sequel}
end
##############################################################################
View
@@ -11,17 +11,16 @@ include FileUtils
NAME = "sequel"
VERS = "1.5.1"
SEQUEL_CORE_VERS= "1.5.1"
-CLEAN.include ["**/.*.sw?", "pkg/*", ".config", "doc/*", "coverage/*"]
-RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source"]
+CLEAN.include ["**/.*.sw?", "pkg/*", ".config", "rdoc/*", "coverage/*"]
+RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', \
+ 'Sequel: The Database Toolkit for Ruby: Model Classes', '--main', 'README']
##############################################################################
# RDoc
##############################################################################
Rake::RDocTask.new do |rdoc|
- rdoc.rdoc_dir = "doc/rdoc"
+ rdoc.rdoc_dir = "rdoc"
rdoc.options += RDOC_OPTS
- rdoc.main = "README"
- rdoc.title = "Sequel: The Database Toolkit for Ruby: Model Classes"
rdoc.rdoc_files.add ["README", "COPYING", "lib/**/*.rb"]
end
View
@@ -10,17 +10,17 @@ include FileUtils
##############################################################################
NAME = "sequel_core"
VERS = "1.5.1"
-CLEAN.include ["**/.*.sw?", "pkg/*", ".config", "doc/*", "coverage/*"]
-RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source"]
+CLEAN.include ["**/.*.sw?", "pkg/*", ".config", "rdoc/*", "coverage/*"]
+RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', \
+ 'Sequel: The Database Toolkit for Ruby: Core Library and Adapters', \
+ '--main', 'README']
##############################################################################
# RDoc
##############################################################################
Rake::RDocTask.new do |rdoc|
- rdoc.rdoc_dir = "doc/rdoc"
+ rdoc.rdoc_dir = "rdoc"
rdoc.options += RDOC_OPTS
- rdoc.main = "README"
- rdoc.title = "Sequel: The Database Toolkit for Ruby: Core Library and Adapters"
rdoc.rdoc_files.add ["README", "COPYING", "lib/**/*.rb"]
end

0 comments on commit d1fadee

Please sign in to comment.