From 310297e1592b0e7b77b86293df8ca63a3d964bf4 Mon Sep 17 00:00:00 2001 From: "Hongli Lai (Phusion)" Date: Mon, 8 Sep 2008 13:35:35 +0200 Subject: [PATCH] Add an index file for the guides. --- railties/Rakefile | 11 ++++++++++- railties/doc/guides/index.txt | 9 +++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 railties/doc/guides/index.txt diff --git a/railties/Rakefile b/railties/Rakefile index a5159dbae62ce..08a5d1797f298 100644 --- a/railties/Rakefile +++ b/railties/Rakefile @@ -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 ---------------------------------------------------------------------------- diff --git a/railties/doc/guides/index.txt b/railties/doc/guides/index.txt new file mode 100644 index 0000000000000..6f5741a12bc45 --- /dev/null +++ b/railties/doc/guides/index.txt @@ -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]