aboutsummaryrefslogtreecommitdiffstats
path: root/railties
diff options
context:
space:
mode:
authorHongli Lai (Phusion) <hongli@phusion.nl>2008-09-08 13:35:35 +0200
committerHongli Lai (Phusion) <hongli@phusion.nl>2008-09-08 13:35:35 +0200
commit310297e1592b0e7b77b86293df8ca63a3d964bf4 (patch)
treeb0ff344ee86d2a37e0b9992796d70b4abb18c6b4 /railties
parent4ba0df6cd27d6e56b456380eb34ebbfe93226e4d (diff)
downloadrails-310297e1592b0e7b77b86293df8ca63a3d964bf4.tar.gz
rails-310297e1592b0e7b77b86293df8ca63a3d964bf4.tar.bz2
rails-310297e1592b0e7b77b86293df8ca63a3d964bf4.zip
Add an index file for the guides.
Diffstat (limited to 'railties')
-rw-r--r--railties/Rakefile11
-rw-r--r--railties/doc/guides/index.txt9
2 files changed, 19 insertions, 1 deletions
diff --git a/railties/Rakefile b/railties/Rakefile
index a5159dbae6..08a5d1797f 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 0000000000..6f5741a12b
--- /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]