diff options
| -rw-r--r-- | Gemfile | 8 | ||||
| -rwxr-xr-x | Rakefile | 2 | ||||
| -rw-r--r-- | railties/guides/rails_guides.rb | 4 | ||||
| -rw-r--r-- | railties/guides/source/contribute.textile | 4 | ||||
| -rw-r--r-- | railties/guides/source/ruby_on_rails_guides_guidelines.textile | 4 | ||||
| -rw-r--r-- | railties/lib/rails/generators/rails/app/templates/Gemfile | 3 |
6 files changed, 15 insertions, 10 deletions
@@ -12,8 +12,12 @@ gem "rack", :git => "git://github.com/rack/rack.git" gem "rake", ">= 0.8.7" gem "mocha", ">= 0.9.8" -gem "rdoc", "~> 3.0" -gem "horo", "= 1.0.3" + +group :doc do + gem "rdoc", "~> 3.4" + gem "horo", "= 1.0.3" + gem "RedCloth", "~> 4.2" +end # for perf tests gem "faker" @@ -1,6 +1,4 @@ #!/usr/bin/env rake -gem 'rdoc', '~> 3.0' -require 'rdoc' require 'rdoc/task' require 'net/http' diff --git a/railties/guides/rails_guides.rb b/railties/guides/rails_guides.rb index dfbb06cc76..feb5fe3937 100644 --- a/railties/guides/rails_guides.rb +++ b/railties/guides/rails_guides.rb @@ -24,14 +24,14 @@ rescue LoadError end begin - gem 'RedCloth', '>= 4.1.1' require 'redcloth' rescue Gem::LoadError + # This can happen if doc:guides is executed in an application. $stderr.puts('Generating guides requires RedCloth 4.1.1+.') $stderr.puts(<<ERROR) if bundler? Please add - gem 'RedCloth', '>= 4.1.1' + gem 'RedCloth', '~> 4.2' to the Gemfile, run diff --git a/railties/guides/source/contribute.textile b/railties/guides/source/contribute.textile index 3d4607de1d..8d19d78324 100644 --- a/railties/guides/source/contribute.textile +++ b/railties/guides/source/contribute.textile @@ -13,8 +13,8 @@ h3. How to Contribute? * Assets are stored in the +railties/guides/assets+ directory. * Sample format : "Active Record Associations":http://github.com/lifo/docrails/blob/3e56a3832415476fdd1cb963980d0ae390ac1ed3/railties/guides/source/association_basics.textile. * Sample output : "Active Record Associations":association_basics.html. -* You can build the Guides during testing by running +rake generate_guides+ in the +railties+ directory. -* You're encouraged to validate XHTML for the generated guides before commiting your changes by running +rake validate_guides+ in the +railties+ directory. +* You can build the Guides during testing by running +bundle exec rake generate_guides+ in the +railties+ directory. +* You're encouraged to validate XHTML for the generated guides before commiting your changes by running +bundle exec rake validate_guides+ in the +railties+ directory. * Edge guides "can be consulted online":http://edgeguides.rubyonrails.org/. That website is generated periodically from docrails. h3. What to Contribute? diff --git a/railties/guides/source/ruby_on_rails_guides_guidelines.textile b/railties/guides/source/ruby_on_rails_guides_guidelines.textile index a2e830b574..655c3462d2 100644 --- a/railties/guides/source/ruby_on_rails_guides_guidelines.textile +++ b/railties/guides/source/ruby_on_rails_guides_guidelines.textile @@ -45,7 +45,7 @@ h3. HTML Generation To generate all the guides just cd into the +railties+ directory and execute <plain> -rake generate_guides +bundle exec rake generate_guides </plain> You'll need the gems erubis, i18n, and RedCloth. @@ -53,7 +53,7 @@ You'll need the gems erubis, i18n, and RedCloth. To process +my_guide.textile+ and nothing else use the +ONLY+ environment variable: <plain> -rake generate_guides ONLY=my_guide +bundle exec rake generate_guides ONLY=my_guide </plain> Although by default guides that have not been modified are not processed, so +ONLY+ is rarely needed in practice. diff --git a/railties/lib/rails/generators/rails/app/templates/Gemfile b/railties/lib/rails/generators/rails/app/templates/Gemfile index 86b9e8f40c..dbd9e8a2f5 100644 --- a/railties/lib/rails/generators/rails/app/templates/Gemfile +++ b/railties/lib/rails/generators/rails/app/templates/Gemfile @@ -26,3 +26,6 @@ source 'http://rubygems.org' # group :development, :test do # gem 'webrat' # end + +# Needed to for guides generation +# gem "RedCloth", "~> 4.2" |