Skip to content

Commit

Permalink
explains why links are gsub'ed, and changes the regexp delimiters
Browse files Browse the repository at this point in the history
  • Loading branch information
fxn committed Jun 19, 2011
1 parent e6f15f0 commit ed4be0a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)
Expand Down

0 comments on commit ed4be0a

Please sign in to comment.