Как документировать больше файлов, чем файл README?

Question

Я использую Ruby on Rails 3.1.0 и гем YARD 0.7.4 для документации.Я хотел бы добавить больше файлов, кроме файла README в начало сгенерированной документации, как сделано здесь (см. README, What's New?, Getting Started Guide, Architecture Overview, ... tabs вверху связанной страницы в разделе «Список файлов»).

То есть, по умолчанию гем YARD генерирует только документацию, связанную с READMEфайл присутствует в каталоге ROOT моего приложения RoR.Я хотел бы документировать другие файлы и для каждого из них добавить вкладку в верхней части документации (как сделано на ранее связанной странице).

Возможно ли это?Если да, то как я могу это сделать? Дополнительно, должен ли я создать новый каталог (в корне моего приложения RoR), содержащий мои «пользовательские» файлы, используемые для целей документации?

Answer 1

При чтении документации для YARD: инструмент командной строки вы найдете следующее:

Вы также можете добавить файл .yardopts в каталог вашего проекта, в котором перечисленыпереключатели, разделенные пробелами (символами новой строки или пробелом), переходят на yardoc при каждом запуске.

Выше есть подсказка, что при использовании - README LICENSE FAQ эти файлы будут добавлены в документацию.1010 *

Сам файл .yardopts для YARD содержит:

-
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

Я думаю, это объясняет, почему все эти файлы являются частью документации.Однако я не знаю, будут ли они автоматически доступны в виде вкладок.