How to document more files besides README file?

Question

I am using Ruby on Rails 3.1.0 and YARD 0.7.4 to create documentation. I would like to add more files except the README at the top of the generated documentation, as here (see README , What New? Getting Started Guide , Architecture Overview , ... tabs at the top of the linked page in the "File List" section )

Thus, by default, the YARD pearl only generates documentation related to the README present in the ROOT directory of my RoR application. I would like to document other files, and for each of them add a tab at the top of the documentation (as done on the previously linked page).

Is it possible? If so, how can I do this? More, should I create a new directory (in the ROOT of my RoR application) containing my "user" files used for documentation purposes?

Answer 1

When reading the documentation for YARD: a command line tool , you will find the following:

You can also add the .yardopts file to the project directory, which lists switches separated by spaces (newlines or spaces) to jump to the yoke whenever it starts.

Above, there is a hint that with the - README LICENSE FAQ these files will be added to the documentation.

. The yardopts file for YARD contains:

 - docs/WhatsNew.md docs/GettingStarted.md docs/Overview.md docs/CodeObjects.md docs/Tags.md docs/Parser.md docs/Handlers.md docs/Templates.md docs/Glossary.md ChangeLog LICENSE LEGAL 

I think this explains why all of these files are part of the documentation. I don’t know if they are available as tabs automatically.