diff options
| -rw-r--r-- | guides/code/getting_started/doc/README_FOR_APP | 2 | ||||
| -rw-r--r-- | guides/source/getting_started.md | 1 | ||||
| -rw-r--r-- | railties/CHANGELOG.md | 6 | ||||
| -rw-r--r-- | railties/lib/rails/generators/rails/app/app_generator.rb | 8 | ||||
| -rw-r--r-- | railties/lib/rails/generators/rails/app/templates/doc/README_FOR_APP | 2 | ||||
| -rw-r--r-- | railties/lib/rails/tasks/documentation.rake | 7 | ||||
| -rw-r--r-- | railties/test/generators/app_generator_test.rb | 1 |
7 files changed, 11 insertions, 16 deletions
diff --git a/guides/code/getting_started/doc/README_FOR_APP b/guides/code/getting_started/doc/README_FOR_APP deleted file mode 100644 index fe41f5cc24..0000000000 --- a/guides/code/getting_started/doc/README_FOR_APP +++ /dev/null @@ -1,2 +0,0 @@ -Use this README file to introduce your application and point to useful places in the API for learning more. -Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries. diff --git a/guides/source/getting_started.md b/guides/source/getting_started.md index 0542cbf514..fb0f4d17db 100644 --- a/guides/source/getting_started.md +++ b/guides/source/getting_started.md @@ -135,7 +135,6 @@ application. Most of the work in this tutorial will happen in the `app/` folder, |config/|Configure your application's runtime rules, routes, database, and more. This is covered in more detail in [Configuring Rails Applications](configuring.html)| |config.ru|Rack configuration for Rack based servers used to start the application.| |db/|Contains your current database schema, as well as the database migrations.| -|doc/|In-depth documentation for your application.| |Gemfile<br />Gemfile.lock|These files allow you to specify what gem dependencies are needed for your Rails application. These files are used by the Bundler gem. For more information about Bundler, see [the Bundler website](http://gembundler.com) | |lib/|Extended modules for your application.| |log/|Application log files.| diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md index dd7e917206..de2d05736a 100644 --- a/railties/CHANGELOG.md +++ b/railties/CHANGELOG.md @@ -1,5 +1,11 @@ ## Rails 4.0.0 (unreleased) ## +* Generated applications no longer get `doc/README_FOR_APP`. In consequence, + the `doc` directory is created on demand by documentation tasks rather than + generated by default. + + *Xavier Noria* + * App executables now live in the `bin/` directory: `bin/bundle`, `bin/rails`, `bin/rake`. Run `rake rails:update:bin` to add these executables to your own app. `script/rails` is gone from new apps. diff --git a/railties/lib/rails/generators/rails/app/app_generator.rb b/railties/lib/rails/generators/rails/app/app_generator.rb index 7d9044a2b4..bf60616e2b 100644 --- a/railties/lib/rails/generators/rails/app/app_generator.rb +++ b/railties/lib/rails/generators/rails/app/app_generator.rb @@ -92,10 +92,6 @@ module Rails directory "db" end - def doc - directory "doc" - end - def lib empty_directory 'lib' empty_directory_with_keep_file 'lib/tasks' @@ -199,10 +195,6 @@ module Rails build(:db) end - def create_doc_files - build(:doc) - end - def create_lib_files build(:lib) end diff --git a/railties/lib/rails/generators/rails/app/templates/doc/README_FOR_APP b/railties/lib/rails/generators/rails/app/templates/doc/README_FOR_APP deleted file mode 100644 index fe41f5cc24..0000000000 --- a/railties/lib/rails/generators/rails/app/templates/doc/README_FOR_APP +++ /dev/null @@ -1,2 +0,0 @@ -Use this README file to introduce your application and point to useful places in the API for learning more. -Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries. diff --git a/railties/lib/rails/tasks/documentation.rake b/railties/lib/rails/tasks/documentation.rake index 2851ca4189..ea6c074bdc 100644 --- a/railties/lib/rails/tasks/documentation.rake +++ b/railties/lib/rails/tasks/documentation.rake @@ -45,7 +45,7 @@ namespace :doc do rdoc.title = ENV['title'] || "Rails Application Documentation" rdoc.options << '--line-numbers' rdoc.options << '--charset' << 'utf-8' - rdoc.rdoc_files.include('doc/README_FOR_APP') + rdoc.rdoc_files.include('README.rdoc') rdoc.rdoc_files.include('app/**/*.rb') rdoc.rdoc_files.include('lib/**/*.rb') } @@ -57,7 +57,10 @@ namespace :doc do rdoc.template = "#{ENV['template']}.rb" if ENV['template'] rdoc.title = "Rails Framework Documentation" rdoc.options << '--line-numbers' - rdoc.rdoc_files.include('README.rdoc') + + gem_path('rails') do |rails| + rdoc.options << '-m' << "#{rails}/README.rdoc" + end gem_path('actionmailer') do |actionmailer| %w(README.rdoc CHANGELOG.md MIT-LICENSE lib/action_mailer/base.rb).each do |file| diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb index 1750149abc..5d5be689e6 100644 --- a/railties/test/generators/app_generator_test.rb +++ b/railties/test/generators/app_generator_test.rb @@ -24,7 +24,6 @@ DEFAULT_APP_FILES = %w( config/initializers config/locales db - doc lib lib/tasks lib/assets |