Skip to content

Commit

Permalink
Sync README and Rakefile with master branch
Browse files Browse the repository at this point in the history
  • Loading branch information
ianwhite committed Feb 9, 2009
1 parent 5c7d637 commit 399f15c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.rdoc
@@ -1,4 +1,4 @@
= {ianwhite}[http://github.com/ianwhite] / inherit_views
= {ianwhite}[http://github.com/ianwhite] / {inherit_views}[http://github.com/ianwhite/inherit_views] >>{info}[http://ianwhite.github.com/inherit_views] >>{api}[http://ianwhite.github.com/inherit_views/doc]

== Status

Expand All @@ -12,7 +12,8 @@ If you're on <b>rails 2.0, or 2.1</b>, you want {inherit_views/rails-2.0-2.1}[ht

== what does it do?

This rails plugin allows your controllers to inherit their views from parent controllers. The default behaviour is to inherit along the ancestor path of the controller, but you can also specify custom inherit view paths to search.
This rails plugin allows your controllers/mailers to inherit their views from parent controllers/mailers.
The default behaviour is to inherit along the ancestor path of the controller/mailer, but you can also specify custom inherit view paths to search.

Example:

Expand All @@ -32,6 +33,14 @@ See InheritViews for more details

NOTE: this plugin is not aimed at having multiple view paths for your controllers, which is addressed with the view_paths addition to ActionController::Base for rails 2.0. Rather, within these view paths, you can inherit views from other controller paths.

== Development mode

Because of recent changes in the way 2.3 finds templates, using inherit_views may result in a noticeable slow-down in development mode.
<b>This slow down will not occur in production mode.</b> (Thanks to {thedarkone}[http://github.com/thedarkone] for pointing this out,
and showing me the reason why).

If you are noticing a slowdown in development mode check out {rails-dev-boost}[http://github.com/thedarkone/rails-dev-boost].

== Testing & CI

RSpec is used for testing, so the tests are in <tt>spec/</tt> rather than
Expand Down
17 changes: 17 additions & 0 deletions Rakefile
Expand Up @@ -45,7 +45,24 @@ Rake::RDocTask.new(:doc) do |t|
t.rdoc_files.include('lib/**/*.rb')
end

namespace :doc do
task :gh_pages => :doc do
`git branch -m gh-pages orig-gh-pages`
`mv doc doctmp`
`git checkout -b gh-pages origin/gh-pages`
`rm -rf doc`
`mv doctmp doc`
`git add doc`
`git commit -m "Update API docs"`
`git push`
`git checkout master`
`git branch -D gh-pages`
`git branch -m orig-gh-pages gh-pages`
end
end

task :cruise do
sh "garlic clean && garlic all"
Rake::Task['doc:gh_pages'].invoke
puts "The build is GOOD"
end

0 comments on commit 399f15c

Please sign in to comment.