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.
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.
rdoc also has this concept of the ".document" file to prevent having to manage these file dependencies in the lib
Also, we should probably be using root
@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"?
@zzak Apparently the doc:app task does not pay attention to .document files, whereas running rdoc directly from the command-line does.
@bitaxis by root i mean the rdoc option
@zzak Being new to RDoc, I am at a loss on what you mean. Can you elaborate more the "rdoc option"?
@bitaxis ping, what is the state of this issue?
@zzak can you maybe take left work over so we can move this forward?
@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 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.
I'll check on this soon, thanks for the reminder
@fxn we plan to remove docs generation from the application right? If so, can we safely close this PR?
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.
After a statistically significant poll on Twitter and some discussion, this task is going to follow the same fate as doc:rails... closing then!
@bitaxis thanks for the patch anyway!
Sure thing. I found a better alternative with yard, actually. Good riddance to doc:* tasks then.