diff --git a/docs/file-scrapers.md b/docs/file-scrapers.md index 51c30d55..bf414592 100644 --- a/docs/file-scrapers.md +++ b/docs/file-scrapers.md @@ -235,6 +235,13 @@ done ### Nokogiri ### Ruby / Minitest ### Ruby on Rails +* Download a release at https://github.com/rails/rails/releases or clone https://github.com/rails/rails.git (checkout to the branch of the rails' version that is going to be scraped) +* Open "railties/lib/rails/api/task.rb" and comment out any code related to sdoc ("configure_sdoc") +* Run "bundle install --without db && bundle exec rake rdoc" (in the Rails directory) +* Run "cd guides && bundle exec rake guides:generate:html" +* Copy the "guides/output" directory to "html/guides" +* Copy the "html" directory to "docs/rails~[version]" + ### Ruby Download the tarball of Ruby from https://www.ruby-lang.org/en/downloads/, extract it, run `./configure && make html` in your terminal (while your are in the ruby directory) and move diff --git a/lib/docs/scrapers/rdoc/rails.rb b/lib/docs/scrapers/rdoc/rails.rb index 1d353539..a4bde522 100644 --- a/lib/docs/scrapers/rdoc/rails.rb +++ b/lib/docs/scrapers/rdoc/rails.rb @@ -1,13 +1,5 @@ module Docs class Rails < Rdoc - # Instructions: - # 1. Download a release at https://github.com/rails/rails/releases - # 2. Open "railties/lib/rails/api/task.rb" and comment out any code related to sdoc ("configure_sdoc") - # 3. Run "bundle install --without db && bundle exec rake rdoc" (in the Rails directory) - # 4. Run "cd guides && bundle exec rake guides:generate:html" - # 5. Copy the "guides/output" directory to "html/guides" - # 6. Copy the "html" directory to "docs/rails~[version]" - include FixInternalUrlsBehavior self.name = 'Ruby on Rails'