From ed4be0a3a41dc53d3d01b7f4592a1a70a9f03121 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Sun, 19 Jun 2011 11:39:52 +0200 Subject: explains why links are gsub'ed, and changes the regexp delimiters --- Rakefile | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'Rakefile') diff --git a/Rakefile b/Rakefile index b3bde156d1..d18dac0dbd 100755 --- a/Rakefile +++ b/Rakefile @@ -61,6 +61,9 @@ RDoc::Task.new do |rdoc| # The temporary solution is to have a README.rdoc without backslashes for # GitHub, and gsub it to generate the main page of the API. # + # Also, relative links in GitHub have to point to blobs, whereas in the API + # they need to point to files. + # # The idea for the future is to have totally different files, since the # API is no longer a generic entry point to Rails and deserves a # dedicated main page specifically thought as an API entry point. @@ -71,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!(/link:blob\/master\/(\w+)\/README.rdoc/, "link:files/\\1/README_rdoc.html") + rdoc_main.gsub!(%r{link: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