Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Have the doc:app rake task process all .rdoc files from both top-level and doc/ directories #11913

Closed
wants to merge 1 commit into from

5 participants

@bitaxis

Have the doc:app rake task process all .rdoc files from both the top-level directory and and the doc/ sub-directory of a Rails application and include them as pages in the generated HTML output, and not just the top-level README.rdoc.

@bitaxis bitaxis Have the doc:app rake task include all .rdoc files from both the top-…
…level directory and and the doc/ sub-directory of a Rails application as pages in the generated output.
267c2db
@zzak
Collaborator

rdoc also has this concept of the ".document" file to prevent having to manage these file dependencies in the lib

@zzak
Collaborator

Also, we should probably be using root

@bitaxis

@zzak I will look into use of the .rdocument file. However I think the lib should have some reasonable defaults. For example, rdoc also has the concept of the main file, which, in my mind, ought to be README.rdoc. But it is not.

Also, can you clarify what you mean by "using root"?

@bitaxis

@zzak Apparently the doc:app task does not pay attention to .document files, whereas running rdoc directly from the command-line does.

@zzak
Collaborator

@bitaxis by root i mean the rdoc option

@bitaxis

@zzak Being new to RDoc, I am at a loss on what you mean. Can you elaborate more the "rdoc option"?

@senny
Owner

@bitaxis ping, what is the state of this issue?

@senny senny added the needs feedback label
@senny
Owner

@zzak can you maybe take left work over so we can move this forward?

@zzak
Collaborator

@senny ofcourse, I plan to work on a release of rdoc this next week, so I'll see if I can figure out what was going on here.

@senny
Owner
@senny senny removed the needs feedback label
@bitaxis

@senny My pull requests still stands. I would like to be able to add multiple .rdoc files to my application, and have rake doc:app pick up and process them. One way I've been able to do so is via this pull request.

@zzak
Collaborator

I'll check on this soon, thanks for the reminder

@rafaelfranca
Owner

@fxn we plan to remove docs generation from the application right? If so, can we safely close this PR?

@fxn
Owner
fxn commented

The plan for Rails 5 is to remove Rails docs tasks like doc:rails, doc:guides, etc. In principle there is nothing planned for app documentation. Though I have never met a team that used this task to be honest.

@fxn
Owner
fxn commented

After a statistically significant poll on Twitter and some discussion, this task is going to follow the same fate as doc:rails... closing then!

@fxn
Owner
fxn commented

@bitaxis thanks for the patch anyway!

@fxn fxn closed this
@bitaxis

Sure thing. I found a better alternative with yard, actually. Good riddance to doc:* tasks then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Aug 16, 2013
  1. @bitaxis

    Have the doc:app rake task include all .rdoc files from both the top-…

    bitaxis authored
    …level directory and and the doc/ sub-directory of a Rails application as pages in the generated output.
This page is out of date. Refresh to see the latest.
Showing with 2 additions and 1 deletion.
  1. +2 −1  railties/lib/rails/tasks/documentation.rake
View
3  railties/lib/rails/tasks/documentation.rake
@@ -50,7 +50,8 @@ else
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('*.rdoc')
+ rdoc.rdoc_files.include('doc/*.rdoc')
rdoc.rdoc_files.include('app/**/*.rb')
rdoc.rdoc_files.include('lib/**/*.rb')
}
Something went wrong with that request. Please try again.