Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The doc:app task should include all .rdoc files #11903

Closed
bitaxis opened this issue Aug 15, 2013 · 3 comments
Closed

The doc:app task should include all .rdoc files #11903

bitaxis opened this issue Aug 15, 2013 · 3 comments
Labels

Comments

@bitaxis
Copy link

@bitaxis bitaxis commented Aug 15, 2013

Rails 4.0.0's doc:app task should process all .rdoc files found at the top level of an app, and not just README.rdoc. Making the following changes to the railties-4.0.0/lib/rails/tasks/documentation.rake file will make it a snap to add a new page, say, CHANGES.rdoc, for example, to the generated HTML output:

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'
  # include all .rdoc files as pages in the HTML output
  # rdoc.rdoc_files.include('README.rdoc')
  rdoc.rdoc_files.include('*.rdoc')
  rdoc.rdoc_files.include('app/**/*.rb')
  rdoc.rdoc_files.include('lib/**/*.rb')
}
@robin850

This comment has been minimized.

Copy link
Member

@robin850 robin850 commented Aug 15, 2013

Could you please send a pull request with this change and maybe a test-case? It would be great!

@bitaxis

This comment has been minimized.

Copy link
Author

@bitaxis bitaxis commented Aug 16, 2013

Pull request #11913 created.

@steveklabnik

This comment has been minimized.

Copy link
Member

@steveklabnik steveklabnik commented Aug 21, 2013

Yup, since this is a feature, not a bug, the PR is good. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.