Remove documentation tasks

This patch removes the tasks doc:app, doc:rails, and doc:guides.

In our experience applications do not generate APIs using doc:app.
Methods may be certainly documented for maintainers, annotated
with YARD tags, etc. but that is intended to be read with the
source code, not in a separate website. Then, teams also have
typically selected topics written down in Markdown files, or in
a GitHub wiki... that kind of thing.

If a team absolutely needs to generate application documentation
for internal purposes, they can still easily write their own task.

Regarding doc:rails and doc:guides, we live in 2015. We are used
to go to online docs all the time. If you really want access to the
API offline RubyGems generates it for every Rails component unless
you tell it not to, and you can checkout the Rails source code to
read the guides as Markdown, or download them for a Kindle reader.

All in all, maintaining this code does not seem to be worthwhile
anymore.

As a consequence of this, guides (+3 MB uncompressed) won't be
distributed with the rails gem anymore. Of course, guides and API
are going to be still part of releases, since documentation is
maintained alongside code and tests.

Also, time permitting, this will allow us to experiment with novel
ways to generate documentation in the Rails docs server, since
right now we were constrained by being able to generate them in
the user's environment.

1 files changed, 0 insertions, 70 deletions

diff --git a/railties/lib/rails/tasks/documentation.rake b/railties/lib/rails/tasks/documentation.rake
deleted file mode 100644
index 8544890553..0000000000
--- a/railties/lib/rails/tasks/documentation.rake
+++ /dev/null
@@ -1,70 +0,0 @@
-begin
-  require 'rdoc/task'
-rescue LoadError
-  # Rubinius installs RDoc as a gem, and for this interpreter "rdoc/task" is
-  # available only if the application bundle includes "rdoc" (normally as a
-  # dependency of the "sdoc" gem.)
-  #
-  # If RDoc is not available it is fine that we do not generate the tasks that
-  # depend on it. Just be robust to this gotcha and go on.
-else
-  require 'rails/api/task'
-
-  # Monkey-patch to remove redoc'ing and clobber descriptions to cut down on rake -T noise
-  class RDocTaskWithoutDescriptions < RDoc::Task
-    include ::Rake::DSL
-
-    def define
-      task rdoc_task_name
-
-      task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
-
-      task clobber_task_name do
-        rm_r rdoc_dir rescue nil
-      end
-
-      task :clobber => [clobber_task_name]
-
-      directory @rdoc_dir
-      task rdoc_task_name => [rdoc_target]
-      file rdoc_target => @rdoc_files + [Rake.application.rakefile] do
-        rm_r @rdoc_dir rescue nil
-        @before_running_rdoc.call if @before_running_rdoc
-        args = option_list + @rdoc_files
-        if @external
-          argstring = args.join(' ')
-          sh %{ruby -Ivendor vendor/rd #{argstring}}
-        else
-          require 'rdoc/rdoc'
-          RDoc::RDoc.new.document(args)
-        end
-      end
-      self
-    end
-  end
-
-  namespace :doc do
-    RDocTaskWithoutDescriptions.new("app") { |rdoc|
-      rdoc.rdoc_dir = 'doc/app'
-      rdoc.template = ENV['template'] if ENV['template']
-      rdoc.title    = ENV['title'] || "Rails Application Documentation"
-      rdoc.options << '--line-numbers'
-      rdoc.options << '--charset' << 'utf-8'
-      rdoc.rdoc_files.include('README.rdoc')
-      rdoc.rdoc_files.include('app/**/*.rb')
-      rdoc.rdoc_files.include('lib/**/*.rb')
-    }
-    Rake::Task['doc:app'].comment = "Generate docs for the app -- also available doc:rails, doc:guides (options: TEMPLATE=/rdoc-template.rb, TITLE=\"Custom Title\")"
-
-    # desc 'Generate documentation for the Rails framework.'
-    Rails::API::AppTask.new('rails')
-  end
-end
-
-namespace :doc do
-  task :guides do
-    rails_gem_dir = Gem::Specification.find_by_name("rails").gem_dir
-    require File.expand_path(File.join(rails_gem_dir, "/guides/rails_guides"))
-    RailsGuides::Generator.new(Rails.root.join("doc/guides")).generate
-  end
-end