[Q] Is it possible to specify top-level module document file explicitly?

[hiroyuki-sato]

Hello, developers.

Is it possible to specify top-level module document file explicitly?
For example, module YARD overview is the following.
Backward compatibility for gem specification lookup

It is written in lib/yard/gem_index.rb file.
Is it possible to write Overview document in lib/yard.rb?

Or, Is it possible to restrict generate the document for the top-level module?

Best regards.

Steps to reproduce

https://github.com/lsegal/yard.git
cd yard
yard server

Open URL http://localhost:8808/docs/YARD

Actual Output

module YARD

Expected Output

I want to specify module document file explicitly.
For example, I want to write module document in lib/yard.rb

Environment details:

• OS: macOS 10.13.6
• Ruby: 2.3.7p456
• YARD: 0.9.16