aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVijay Dev <vijaydev.cse@gmail.com>2011-06-18 23:45:59 +0530
committerVijay Dev <vijaydev.cse@gmail.com>2011-06-18 23:45:59 +0530
commit96c57d4bd0678103d28a87b455e4aef2a7e285b4 (patch)
tree73c952e99d8a6efe8f382d33d1ca7cbd9894ddc1
parent2fbb7504e2c2b0a95398d1ef0c97ea4a403d831d (diff)
downloadrails-96c57d4bd0678103d28a87b455e4aef2a7e285b4.tar.gz
rails-96c57d4bd0678103d28a87b455e4aef2a7e285b4.tar.bz2
rails-96c57d4bd0678103d28a87b455e4aef2a7e285b4.zip
To solve the problem of links being broken in GitHub for the sake of api site, have them replaced at runtime during rdoc generation
-rw-r--r--README.rdoc4
-rwxr-xr-xRakefile1
2 files changed, 3 insertions, 2 deletions
diff --git a/README.rdoc b/README.rdoc
index 7e2d7850c8..bca2126559 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -18,7 +18,7 @@ you to present the data from database rows as objects and embellish these data o
with business logic methods. Although most Rails models are backed by a database, models
can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as
provided by the ActiveModel module. You can read more about Active Record in its
-{README}[link:files/activerecord/README_rdoc.html].
+{README}[link:blob/master/activerecord/README.rdoc].
The Controller layer is responsible for handling incoming HTTP requests and providing a
suitable response. Usually this means returning HTML, but Rails controllers can also
@@ -29,7 +29,7 @@ In Rails, the Controller and View layers are handled together by Action Pack.
These two layers are bundled in a single package due to their heavy interdependence.
This is unlike the relationship between the Active Record and Action Pack which are
independent. Each of these packages can be used independently outside of Rails. You
-can read more about Action Pack in its {README}[link:files/actionpack/README_rdoc.html].
+can read more about Action Pack in its {README}[link:blob/master/actionpack/README.rdoc].
== Getting Started
diff --git a/Rakefile b/Rakefile
index ba55e580f4..b3bde156d1 100755
--- a/Rakefile
+++ b/Rakefile
@@ -71,6 +71,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")
File.open(RDOC_MAIN, 'w') do |f|
f.write(rdoc_main)