From c3bd6bb75fdbeb8f5d92b12ed2a9f5d4958d2f9c Mon Sep 17 00:00:00 2001 From: Vijay Dev Date: Sat, 13 Aug 2011 22:14:18 +0530 Subject: Fixes readme links better - earlier links broke when the current page is anything other than github.com/rails/rails/. Even github.com/rails/rails (without the trailing slash) broke the readme links. Also change the rakefile that generates the rdoc readme accordingly --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Rakefile') diff --git a/Rakefile b/Rakefile index d18dac0dbd..36007f6e91 100755 --- a/Rakefile +++ b/Rakefile @@ -74,7 +74,7 @@ RDoc::Task.new do |rdoc| # since no autolinking happens there and RDoc displays the backslash # otherwise. rdoc_main.gsub!(/^(?=\S).*?\b(?=Rails)\b/) { "#$&\\" } - rdoc_main.gsub!(%r{link:blob/master/(\w+)/README\.rdoc}, "link:files/\\1/README_rdoc.html") + rdoc_main.gsub!(%r{link:/rails/rails/blob/master/(\w+)/README\.rdoc}, "link:files/\\1/README_rdoc.html") File.open(RDOC_MAIN, 'w') do |f| f.write(rdoc_main) -- cgit v1.2.3 From 71232f5d5d88d5390ff790b7b3336f5168e9f270 Mon Sep 17 00:00:00 2001 From: Anand Date: Mon, 22 Aug 2011 17:07:23 +0530 Subject: Travis status image added to GitHub README, excluding API pages. --- Rakefile | 3 +++ 1 file changed, 3 insertions(+) (limited to 'Rakefile') diff --git a/Rakefile b/Rakefile index 36007f6e91..4cf01cf063 100755 --- a/Rakefile +++ b/Rakefile @@ -76,6 +76,9 @@ RDoc::Task.new do |rdoc| rdoc_main.gsub!(/^(?=\S).*?\b(?=Rails)\b/) { "#$&\\" } rdoc_main.gsub!(%r{link:/rails/rails/blob/master/(\w+)/README\.rdoc}, "link:files/\\1/README_rdoc.html") + # Remove Travis build status image from API pages. Only GitHub README page gets this image + rdoc_main.gsub!("http://travis-ci.org/rails/rails.png", "") + File.open(RDOC_MAIN, 'w') do |f| f.write(rdoc_main) end -- cgit v1.2.3 From 827a0fee07eff7ca35ecdf5ca650f2094ad4825a Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Sat, 27 Aug 2011 03:55:01 -0700 Subject: use sdoc to generate the API --- Rakefile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'Rakefile') diff --git a/Rakefile b/Rakefile index 4cf01cf063..ae857036c5 100755 --- a/Rakefile +++ b/Rakefile @@ -1,6 +1,7 @@ #!/usr/bin/env rake require 'rdoc/task' +require 'sdoc' require 'net/http' $:.unshift File.expand_path('..', __FILE__) @@ -89,7 +90,8 @@ RDoc::Task.new do |rdoc| rdoc.rdoc_dir = 'doc/rdoc' rdoc.title = "Ruby on Rails Documentation" - rdoc.options << '-f' << 'horo' + rdoc.options << '-f' << 'sdoc' + rdoc.options << '-T' << 'rails' rdoc.options << '-c' << 'utf-8' rdoc.options << '-m' << RDOC_MAIN -- cgit v1.2.3 From 5aa86f793f4df75f8a5780626269abc3511c61a0 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Mon, 29 Aug 2011 15:47:56 -0700 Subject: let SDoc add a link to the source code in GitHub for each method --- Rakefile | 1 + 1 file changed, 1 insertion(+) (limited to 'Rakefile') diff --git a/Rakefile b/Rakefile index ae857036c5..f171949961 100755 --- a/Rakefile +++ b/Rakefile @@ -93,6 +93,7 @@ RDoc::Task.new do |rdoc| rdoc.options << '-f' << 'sdoc' rdoc.options << '-T' << 'rails' rdoc.options << '-c' << 'utf-8' + rdoc.options << '-g' # SDoc flag, link methods to GitHub rdoc.options << '-m' << RDOC_MAIN rdoc.rdoc_files.include('railties/CHANGELOG') -- cgit v1.2.3 From 82de8ad9c140afa81d334780e96428ef10ce52e8 Mon Sep 17 00:00:00 2001 From: Vijay Dev Date: Thu, 8 Sep 2011 01:27:24 +0530 Subject: Use Travis https build status image in order to prevent GitHub from caching the http version. The syntax for including an https image url in RDoc taken from http://about.travis-ci.org/docs/user/status-images. Having this in a line of its own now to make regex replacement for the API simpler! --- Rakefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Rakefile') diff --git a/Rakefile b/Rakefile index f171949961..a47d415abc 100755 --- a/Rakefile +++ b/Rakefile @@ -78,7 +78,8 @@ RDoc::Task.new do |rdoc| rdoc_main.gsub!(%r{link:/rails/rails/blob/master/(\w+)/README\.rdoc}, "link:files/\\1/README_rdoc.html") # Remove Travis build status image from API pages. Only GitHub README page gets this image - rdoc_main.gsub!("http://travis-ci.org/rails/rails.png", "") + # https build image is used to avoid GitHub caching: http://about.travis-ci.org/docs/user/status-images + rdoc_main.gsub!(%r{^== Travis.*}, '') File.open(RDOC_MAIN, 'w') do |f| f.write(rdoc_main) -- cgit v1.2.3 From 8e5686658eef0eb10a1a1edb91890a062736dfb4 Mon Sep 17 00:00:00 2001 From: Rahul Chaudhari Date: Tue, 8 Nov 2011 11:38:33 +0530 Subject: Updated Rakefile as CHANGELOG has been renamed to CHANGELOG.md --- Rakefile | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'Rakefile') diff --git a/Rakefile b/Rakefile index a47d415abc..e59abd5758 100755 --- a/Rakefile +++ b/Rakefile @@ -97,24 +97,24 @@ RDoc::Task.new do |rdoc| rdoc.options << '-g' # SDoc flag, link methods to GitHub rdoc.options << '-m' << RDOC_MAIN - rdoc.rdoc_files.include('railties/CHANGELOG') + rdoc.rdoc_files.include('railties/CHANGELOG.md') rdoc.rdoc_files.include('railties/MIT-LICENSE') rdoc.rdoc_files.include('railties/README.rdoc') rdoc.rdoc_files.include('railties/lib/**/*.rb') rdoc.rdoc_files.exclude('railties/lib/rails/generators/**/templates/**/*.rb') rdoc.rdoc_files.include('activerecord/README.rdoc') - rdoc.rdoc_files.include('activerecord/CHANGELOG') + rdoc.rdoc_files.include('activerecord/CHANGELOG.md') rdoc.rdoc_files.include('activerecord/lib/active_record/**/*.rb') rdoc.rdoc_files.exclude('activerecord/lib/active_record/vendor/*') rdoc.rdoc_files.include('activeresource/README.rdoc') - rdoc.rdoc_files.include('activeresource/CHANGELOG') + rdoc.rdoc_files.include('activeresource/CHANGELOG.md') rdoc.rdoc_files.include('activeresource/lib/active_resource.rb') rdoc.rdoc_files.include('activeresource/lib/active_resource/*') rdoc.rdoc_files.include('actionpack/README.rdoc') - rdoc.rdoc_files.include('actionpack/CHANGELOG') + rdoc.rdoc_files.include('actionpack/CHANGELOG.md') rdoc.rdoc_files.include('actionpack/lib/abstract_controller/**/*.rb') rdoc.rdoc_files.include('actionpack/lib/action_controller/**/*.rb') rdoc.rdoc_files.include('actionpack/lib/action_dispatch/**/*.rb') @@ -122,18 +122,18 @@ RDoc::Task.new do |rdoc| rdoc.rdoc_files.exclude('actionpack/lib/action_controller/vendor/*') rdoc.rdoc_files.include('actionmailer/README.rdoc') - rdoc.rdoc_files.include('actionmailer/CHANGELOG') + rdoc.rdoc_files.include('actionmailer/CHANGELOG.md') rdoc.rdoc_files.include('actionmailer/lib/action_mailer/base.rb') rdoc.rdoc_files.include('actionmailer/lib/action_mailer/mail_helper.rb') rdoc.rdoc_files.exclude('actionmailer/lib/action_mailer/vendor/*') rdoc.rdoc_files.include('activesupport/README.rdoc') - rdoc.rdoc_files.include('activesupport/CHANGELOG') + rdoc.rdoc_files.include('activesupport/CHANGELOG.md') rdoc.rdoc_files.include('activesupport/lib/active_support/**/*.rb') rdoc.rdoc_files.exclude('activesupport/lib/active_support/vendor/*') rdoc.rdoc_files.include('activemodel/README.rdoc') - rdoc.rdoc_files.include('activemodel/CHANGELOG') + rdoc.rdoc_files.include('activemodel/CHANGELOG.md') rdoc.rdoc_files.include('activemodel/lib/active_model/**/*.rb') end -- cgit v1.2.3