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

Conversation

Projects
None yet
5 participants

bitaxis commented Aug 16, 2013

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
Member

zzak commented Aug 16, 2013

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

Member

zzak commented Aug 16, 2013

Also, we should probably be using root

bitaxis commented Aug 18, 2013

@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 commented Aug 22, 2013

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

Member

zzak commented Sep 13, 2013

@bitaxis by root i mean the rdoc option

bitaxis commented Sep 13, 2013

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

Owner

senny commented Feb 3, 2014

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

senny added the needs feedback label Feb 3, 2014

Owner

senny commented Mar 8, 2014

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

Member

zzak commented Mar 8, 2014

@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.

Owner

senny commented Mar 8, 2014

@zzak ❤️

senny removed the needs feedback label Mar 17, 2014

bitaxis commented Jul 4, 2014

@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.

Member

zzak commented Jul 4, 2014

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

Owner

rafaelfranca commented Feb 6, 2015

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

Owner

fxn commented Feb 6, 2015

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.

Owner

fxn commented Feb 6, 2015

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

Owner

fxn commented Feb 6, 2015

@bitaxis thanks for the patch anyway!

fxn closed this Feb 6, 2015

bitaxis commented Feb 7, 2015

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