Permalink
Browse files

Add an index file for the guides.

  • Loading branch information...
1 parent 4ba0df6 commit 310297e1592b0e7b77b86293df8ca63a3d964bf4 @FooBarWidget FooBarWidget committed Sep 8, 2008
Showing with 19 additions and 1 deletion.
  1. +10 −1 railties/Rakefile
  2. +9 −0 railties/doc/guides/index.txt
View
@@ -272,6 +272,9 @@ Rake::RDocTask.new { |rdoc|
rdoc.rdoc_files.include('lib/commands/**/*.rb')
}
+# In this array, one defines the guides for which HTML output should be
+# generated. Specify the folder names of the guides. If the .txt filename
+# doesn't equal its folder name, then specify a hash: { 'folder_name' => 'filename.txt' }
guides = [
'securing_rails_applications',
'testing_rails_applications',
@@ -280,7 +283,8 @@ guides = [
{ 'routing' => 'routing_outside_in' },
{ 'debugging' => 'debugging_rails_applications' }
]
-guides_html_files = []
+
+guides_html_files = [] # autogenerated from the 'guides' variable.
guides.each do |entry|
if entry.is_a?(Hash)
guide_folder = entry.keys.first
@@ -297,8 +301,13 @@ guides.each do |entry|
end
end
+file 'doc/guides/index.html' => 'doc/guides/index.txt' do
+ sh "mizuho", 'doc/guides/index.txt', "--template", "manualsonrails", "--icons-dir", "icons"
+end
+
desc "Generate HTML output for the guides"
task :generate_guides => guides_html_files
+task :generate_guides => 'doc/guides/index.html'
# Generate GEM ----------------------------------------------------------------------------
@@ -0,0 +1,9 @@
+Ruby on Rails guides
+====================
+
+* link:migrations/migrations.html[Guide to Rails Database Migrations]
+* link:testing_rails_applications/testing_rails_applications.html[Testing Rails Applications]
+* link:securing_rails_applications/securing_rails_applications.html[Securing Rails Applications]
+* link:routing/routing_outside_in.html[Routing Outside-In]
+* link:debugging/debugging_rails_applications.html[Debugging Rails Applications]
+* link:creating_plugins/creating_plugins.html[The Basics of Creating Rails Plugins]

0 comments on commit 310297e

Please sign in to comment.