The main page should not also be listed in its filesystem location

[mm-stefan]

I have tried making the contents of README_FOR_APP the entry point for my RDoc as follows:

       rdoc.main     = 'doc/README_FOR_APP'                   # define README_FOR_APP as index
       rdoc.rdoc_files.include('doc/README_FOR_APP')

This seems to:

• Generate the contents of README_FOR_APP into index.html in the RDoc output
• Create an RDoc for README_FOR_APP in #{rdoc.rdoc_dir}/doc

The entry point for the RDoc when viewed in the browser is index.html, and the page displayed contains a link in the 'Pages' block on the left, which points to #{rdoc.rdoc_dir}/doc.

The problem arises when README_FOR_APP itself contains links to other RDoc files generated. I can get these to work with the appropriate leading relative path in either of the two cases, but not both, since the index.html and doc/README_FOR_APP are in different dirs.

I have found a workaround in placing README_FOR_APP in Rails.root and removing the leading 'doc' entries from the config:

       rdoc.main     = 'README_FOR_APP'                   # define README_FOR_APP as index
       rdoc.rdoc_files.include('README_FOR_APP')

... but it should not be necessary to pollute Rails.root with docs ...

[drbrain]

Yes, I have had a difficult time getting around to fixing this.

I've updated the title to make the issue more clear.

[federicoaldunate]

@drbrain I can try to fix this. Do you know a guideline on how to do it? I'm not quite familiar with this repository